NETMOD Q. Ma, Ed. Internet-Draft Q. Wu Updates: 8342 (if approved) Huawei Intended status: Standards Track C. Feng Expires: 9 June 2025 6 December 2024 System-defined Configuration draft-ietf-netmod-system-config-10 Abstract The Network Management Datastore Architecture (NMDA) in RFC 8342 defines several configuration datastores holding configuration. The contents of these configuration datastores are controlled by clients. This document introduces the concept of system configuration datastore holding configuration controlled by the system on which a server is running. The system configuration can be referenced (e.g., leafref) by configuration explicitly created by clients. This document updates RFC 8342. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 9 June 2025. Copyright Notice Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights Ma, et al. Expires 9 June 2025 [Page 1] Internet-Draft System-defined Configuration December 2024 and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Requirements Language . . . . . . . . . . . . . . . . . . 5 1.3. Updates to RFC 8342 . . . . . . . . . . . . . . . . . . . 5 2. Kinds of System Configuration . . . . . . . . . . . . . . . . 5 2.1. Immediately-Present . . . . . . . . . . . . . . . . . . . 5 2.2. Conditionally-Present . . . . . . . . . . . . . . . . . . 6 3. The System Configuration Datastore () . . . . . . . . 6 4. Conceptual Model of Datastores . . . . . . . . . . . . . . . 7 5. Static Characteristics . . . . . . . . . . . . . . . . . . . 9 5.1. Read-only to Clients . . . . . . . . . . . . . . . . . . 9 5.2. No Impact to . . . . . . . . . . . . . . . 9 6. Dynamic Behaviors . . . . . . . . . . . . . . . . . . . . . . 9 6.1. May Change via Software Upgrades or Resource Changes . . 9 6.2. Referencing System Configuration . . . . . . . . . . . . 10 6.3. Modifying (Overriding) System Configuration . . . . . . . 10 6.4. Configuring Descendant nodes of System Configuration . . 11 7. Relationships to Other Datastores . . . . . . . . . . . . . . 11 7.1. The "factory-default" Datastore . . . . . . . . . . . . . 11 8. The "ietf-system-datastore" Module . . . . . . . . . . . . . 11 8.1. Data Model Overview . . . . . . . . . . . . . . . . . . . 11 8.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 12 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13 9.1. The "IETF XML" Registry . . . . . . . . . . . . . . . . . 13 9.2. The "YANG Module Names" Registry . . . . . . . . . . . . 13 10. Security Considerations . . . . . . . . . . . . . . . . . . . 14 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 14 11.1. Normative References . . . . . . . . . . . . . . . . . . 14 11.2. Informative References . . . . . . . . . . . . . . . . . 15 Appendix A. Example of Dynamic Behaviors . . . . . . . . . . . . 16 A.1. Referencing System-defined Nodes . . . . . . . . . . . . 17 A.2. Modifying a System-instantiated Leaf's Value . . . . . . 22 A.3. Configuring Descendant Nodes of a System-defined Node . . 23 Appendix B. Key Use Cases . . . . . . . . . . . . . . . . . . . 24 B.1. Device Powers On . . . . . . . . . . . . . . . . . . . . 26 B.2. Client Commits Configuration . . . . . . . . . . . . . . 26 B.3. Operator Installs Card into a Chassis . . . . . . . . . . 28 B.4. Client further Commits Configuration . . . . . . . . . . 29 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 31 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 32 Ma, et al. Expires 9 June 2025 [Page 2] Internet-Draft System-defined Configuration December 2024 1. Introduction The Network Management Datastore Architecture (NMDA) [RFC8342] defines system configuration as the configuration that is supplied by the device itself and appears in when it is in use (Figure 2 in [RFC8342]). However, there is a desire to enable a server to better expose the system configuration, regardless of whether it is in use. For example, some implementations defines the system configuration which must be referenced to be active. NETCONF/RESTCONF clients can benefit from a standard mechanism to retrieve what system configuration is available on a server. Some servers allow the descendant nodes of system-defined configuration to be configured or modified. For example, the system configuration may contain an almost empty physical interface, while the client needs to be able to add, modify, or remove a number of descendant nodes. Some descendant nodes may not be modifiable (e.g., the interface "type" set by the system). This document updates the NMDA defined in [RFC8342] with a read-only conventional configuration datastore called "system" to expose system-defined configuration. The solution enables configuration explicitly created by the clients to reference nodes defined in , override system-provided values, and configure descendant nodes of system-defined configuration. The solution defined in this document requires the use of NMDA for both clients and servers. Conformance to this document requires NMDA servers implement the "ietf-system-datastore" YANG module (Section 8). 1.1. Terminology This document assumes that the reader is familiar with the contents of [RFC6241], [RFC7950], [RFC8342], [RFC8407], and [RFC8525] and uses terminologies from those documents. The following terms are defined in this document: system configuration: Configuration that is provided by the system Ma, et al. Expires 9 June 2025 [Page 3] Internet-Draft System-defined Configuration December 2024 itself. System configuration is present in the system configuration datastore (regardless of whether it is applied or referenced). It is a different and separate concept from factory default configuration defined in [RFC8808] (which represents a preset initial configuration that is used to initialize the configuration of a server). System configuration may also be referred to as "system-defined configuration" or "system-provided configuration" throughout this document. system configuration datastore: A configuration datastore holding configuration provided by the system itself. This datastore is referred to as "". This document redefines the term "conventional configuration datastore" in Section 3 of [RFC8342] to add "system" to the list of conventional configuration datastores: conventional configuration datastore: One of the following set of configuration datastores: , , , , and . These datastores share a common datastore schema, and protocol operations allow copying data between these datastores. The term "conventional" is chosen as a generic umbrella term for these datastores. system node: An instance in the data tree that is provided by the system itself. System node may also be called "system-defined node" or "system-provided node" throughout this document. referenced node: A referenced node is one of: * Targets of leafref values defined via the "path" statement. * Targets of "instance-identifier" type values. * Nodes present in an XPath expression of "when" constraints. * Nodes present in an XPath expression of "must" constraints. * Nodes defined to satisfy the "mandatory true" constraints. * Nodes defined to satisfy the "min-elements" constraints. Ma, et al. Expires 9 June 2025 [Page 4] Internet-Draft System-defined Configuration December 2024 1.2. Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 1.3. Updates to RFC 8342 This document updates RFC 8342 to define a configuration datastore called "system" to hold system configuration (Section 3), it also redefines the term "conventional configuration datastore" from [RFC8342] to add "system" to the list of conventional configuration datastores. Configuration in is merged with to create the contents of after the configuration transformations (e.g., template expansion, removal of inactive configuration defined in [RFC8342]) have been performed, as described in Section 4. This document also updates the definition of "intended" origin metadata annotation identity defined in Section 5.3.4 of [RFC8342]. The "intended" identity of origin value defined in [RFC8342] represents the origin of configuration provided by , this document updates its definition as the origin source of configuration explicitly provided by clients, and allows a subset of configuration in that flows from yet is not configured or overridden explicitly in to use "system" as its origin value. 2. Kinds of System Configuration This document defines two types of system configuration. Configuration that is immediately-present and configuration that is conditionally-present. These types of system configuration are described in Section 2.1 and Section 2.2, respectively. 2.1. Immediately-Present Immediately-present refers to system configuration which is generated in when the device is powered on, irrespective of physical resource present or not, a special functionality enabled or not. An example of immediately-present system configuration is an always- existing loopback interface. Ma, et al. Expires 9 June 2025 [Page 5] Internet-Draft System-defined Configuration December 2024 2.2. Conditionally-Present Conditionally-present refers to system configuration which is generated in based on specific conditions being met in a system. For example, if a physical resource is present (e.g., an interface card is inserted), the system automatically detects it and loads associated configuration; when the physical resource is not present (an interface card is removed), the system configuration will be automatically cleared. Another example is when a special functionality is enabled, e.g., when a license or feature is enabled, specific configuration may be created by the system. 3. The System Configuration Datastore () Following guidelines for defining datastores in the Appendix A of [RFC8342], this document introduces a new datastore resource named "system" that represents the system configuration. NMDA servers compliant with this document MUST implement a system configuration datastore, and they SHOULD also implement . * Name: "system". * YANG modules: all. * YANG nodes: all "config true" data nodes up to the root of the tree, generated by the system. * Management operations: The datastore can be read using network management protocols such as NETCONF and RESTCONF, but its contents cannot be changed by manage operations via NETCONF and RESTCONF protocols. * Origin: This document does not define any new origin identity. The "system" identity of origin metadata annotation [RFC7952] is used to indicate the origin of a data item provided by the system. * Protocols: YANG-driven management protocols, such as NETCONF and RESTCONF. * Defining YANG module: "ietf-system-datastore" (Section 8). The system configuration datastore doesn't persist across reboots. Ma, et al. Expires 9 June 2025 [Page 6] Internet-Draft System-defined Configuration December 2024 4. Conceptual Model of Datastores Clients may provide configuration nodes that reference nodes defined in , override system-provided values, and configure descendant nodes of system-defined configuration in , as detailed in Section 6. To ensure the validity of , configuration in is merged with to become , in which process, configuration appearing in takes precedence over the same node in . Since it is unspecified how to merge configuration before transformations, if or includes configuration that requires further transformation (e.g., template expansion, removal of inactive configuration defined in [RFC8342]) before it can be applied, configuration transformations MUST be performed before is merged with . Whenever configuration in changes, the server MUST also immediately update and validate . As a result, Figure 2 in Section 5 of [RFC8342] is updated with the below conceptual model of datastores which incorporates the system configuration datastore. Ma, et al. Expires 9 June 2025 [Page 7] Internet-Draft System-defined Configuration December 2024 +-------------+ +-----------+ | | | | | (ct, rw) |<---+ +---->| (ct, rw) | +-------------+ | | +-----------+ | | | | +-----------+ | +-----------+ | | | +------->| |<--------+ | (ct, ro) | | (ct, rw) | +-----------+ +-----------+ | | | | | | // configuration transformations, +--------------+---------------+ // e.g., removal of nodes marked | // as "inactive", expansion of | // templates v +------------+ | | // subject to validation | (ct, ro) | +------------+ | // changes applied, subject to | // local factors, e.g., missing | // resources, delays dynamic | configuration | +-------- learned configuration datastores -----+ | +-------- default configuration | | | v v v +---------------+ | | <-- system state | (ct + cf, ro) | +---------------+ ct = config true; cf = config false rw = read-write; ro = read-only boxes denote named datastores Figure 1: Architectural Model of Datastores Ma, et al. Expires 9 June 2025 [Page 8] Internet-Draft System-defined Configuration December 2024 Configuration in is undeletable to clients (e.g., a system- defined list entry can never be removed), even though a node defined in may be overridden in . If it is desired to enable a client to delete system configuration, it can be approximated using , as described in Section 7.1. If system initializes a value for a particular leaf which is overridden by the client with a different value in (Section 6.3), the node in may be removed later, in which case system-initialized value defined in may still be in use and appear in . 5. Static Characteristics 5.1. Read-only to Clients The system datastore is read-only (i.e., edits towards directly MUST be denied), though the client may be allowed to provide configuration that overrides the value of a system-initialized node (see Section 6.3). 5.2. No Impact to This work has no impact to . Notably, it does not define any new origin identity as it is able to use the existing "system" identity defined in Section 5.3.4 of [RFC8342]. This document does not assert that all configuration nodes in with origin "system" originate from , especially in cases where it is ambiguous which origin should be used. enables system-generated nodes to be defined like configuration, i.e., made visible to clients in order for being referenced or configurable prior to present in . "config false" nodes are out of scope, hence existing "config false" nodes are not impacted by this work. 6. Dynamic Behaviors 6.1. May Change via Software Upgrades or Resource Changes The contents of MAY change dynamically under various conditions, such as license change, software upgrade, and system- controlled resources change (see Section 2.2). The updates of system configuration may be obtained through YANG notifications (e.g., on- change notification) [RFC8639][RFC8641]. Ma, et al. Expires 9 June 2025 [Page 9] Internet-Draft System-defined Configuration December 2024 Servers MUST ensure that any updates of do not render invalid. However, any mechanism for handling these circumstances is outside the scope of this document. That said, here are some examples of how a server might behave ensuring (and ) remains valid: * Servers migrate references in from old system-defined nodes to new system-defined nodes, assuming that the new references have the same semantic properties as the old reference. Since this migration changes data in , it is RECOMMENDED to alert clients that such change may occur. * Servers copy referenced system-defined nodes into . Since this migration changes data in , it is RECOMMENDED to alert clients that such change may occur. * Servers reject the operation to change system configuration (e.g., software upgrade fails) and needs the client to update the configuration in as a prerequisite. Servers are RECOMMENDED to include some hints in error responses to help clients understand how should be updated. 6.2. Referencing System Configuration Clients may create configuration data in that references nodes in . Some implementations may define system nodes solely as a convenience for clients to reference. It is also possible for the clients to define their customized nodes for reference. Appendix A.1 provides an example of a client referencing system- defined nodes. 6.3. Modifying (Overriding) System Configuration In some cases, a server may allow some parts of system configuration (e.g., a leaf's value) to be modified. Modification of system configuration is achieved by the client writing configuration data in that overrides the values of matched configuration nodes at the corresponding level in . Configurations defined in take precedence over system configuration nodes in if the server allows the nodes to be modified. The immutability of system configuration is defined in [I-D.ietf-netmod-immutable-flag]. Appendix A.2 provides an example of a client overriding a system- instantiated leaf's value. Ma, et al. Expires 9 June 2025 [Page 10] Internet-Draft System-defined Configuration December 2024 6.4. Configuring Descendant nodes of System Configuration A server may also allow a client to add nodes to a list entry in by writing those additional nodes in . Those additional data nodes may not exist in (i.e., an addition rather than an override). Appendix A.3 provides an example of a client configuring descendant nodes of a system-defined node. 7. Relationships to Other Datastores This section discusses the interesting relationships of to other datastores known at the time of this writing. 7.1. The "factory-default" Datastore Any deletable system-provided configuration that is populated as part of by the system at boot up, without being part of the contents of a datastore, must be defined in [RFC8808], which is used to initialize when the device is first-time powered on or reset to its factory default condition. The RPC operation can reset to its factory default contents. 8. The "ietf-system-datastore" Module 8.1. Data Model Overview This YANG module defines a new YANG identity named "system" that uses the "ds: conventional" identity defined in [RFC8342] as its base. A client can discover the system configuration datastore support on the server by reading the YANG library information from the operational state datastore. The system datastore is defined as a conventional configuration datastore and shares a common datastore schema with other conventional datastores. The following diagram illustrates the relationship amongst the "identity" statements defined in the "ietf-system-datastore" and "ietf-datastores" YANG modules: Ma, et al. Expires 9 June 2025 [Page 11] Internet-Draft System-defined Configuration December 2024 Identities: +--- datastore | +--- conventional | | +--- running | | +--- candidate | | +--- startup | | +--- system | | +--- intended | +--- dynamic | +--- operational The diagram above uses syntax that is similar to but not defined in [RFC8340]. 8.2. YANG Module file "ietf-system-datastore@2024-12-06.yang" module ietf-system-datastore { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-system-datastore"; prefix sysds; import ietf-datastores { prefix ds; reference "RFC 8342: Network Management Datastore Architecture(NMDA)"; } organization "IETF NETMOD (Network Modeling) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netmod/ WG List: NETMOD WG list Author: Qiufang Ma Author: Qin Wu Author: Chong Feng "; description "This module defines a new YANG identity that uses the ds:conventional identity defined in [RFC8342]. Copyright (c) 2024 IETF Trust and the persons identified as authors of the code. All rights reserved. Ma, et al. Expires 9 June 2025 [Page 12] Internet-Draft System-defined Configuration December 2024 Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; revision 2024-12-06 { description "Initial version."; reference "RFC XXXX: System-defined Configuration"; } identity system { base ds:conventional; description "This read-only datastore contains the configuration provided by the system itself."; } } 9. IANA Considerations 9.1. The "IETF XML" Registry This document registers two XML namespace URNs in the 'IETF XML registry', following the format defined in [RFC3688]. URI: urn:ietf:params:xml:ns:yang:ietf-system-datastore Registrant Contact: The IESG. XML: N/A, the requested URIs are XML namespaces. 9.2. The "YANG Module Names" Registry This document registers two module names in the 'YANG Module Names' registry, defined in [RFC6020]. Ma, et al. Expires 9 June 2025 [Page 13] Internet-Draft System-defined Configuration December 2024 name: ietf-system-datastore prefix: sysds namespace: urn:ietf:params:xml:ns:yang:ietf-system-datatstore maintained by IANA? N RFC: XXXX // RFC Ed.: replace XXXX and remove this comment 10. Security Considerations This section is modeled after the template described in Section 3.7 of [I-D.ietf-netmod-rfc8407bis]. The "ietf-system-datastore" YANG module defines a data model that is designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. These protocols have to use a secure transport layer (e.g., SSH [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and have to use mutual authentication. The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. The YANG module only defines a identity that uses the "ds:conventional" identity as its base. The module by itself does not expose any data nodes that are writable, date nodes that contain read-only state, or RPCs. As such, there are no additional security issues related to the YANG module that need to be considered. 11. References 11.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . Ma, et al. Expires 9 June 2025 [Page 14] Internet-Draft System-defined Configuration December 2024 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, . [RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Subscription to YANG Notifications", RFC 8639, DOI 10.17487/RFC8639, September 2019, . [RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641, September 2019, . 11.2. Informative References [I-D.ietf-netmod-immutable-flag] Ma, Q., Wu, Q., Lengyel, B., and H. Li, "YANG Metadata Annotation for Immutable Flag", Work in Progress, Internet-Draft, draft-ietf-netmod-immutable-flag-02, 27 September 2024, . [I-D.ietf-netmod-rfc8407bis] Bierman, A., Boucadair, M., and Q. Wu, "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", Work in Progress, Internet-Draft, draft-ietf- netmod-rfc8407bis-21, 13 November 2024, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252, January 2006, . Ma, et al. Expires 9 June 2025 [Page 15] Internet-Draft System-defined Configuration December 2024 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, . [RFC7952] Lhotka, L., "Defining and Using Metadata with YANG", RFC 7952, DOI 10.17487/RFC7952, August 2016, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", BCP 216, RFC 8407, DOI 10.17487/RFC8407, October 2018, . [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, . [RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., and R. Wilton, "YANG Library", RFC 8525, DOI 10.17487/RFC8525, March 2019, . [RFC8808] Wu, Q., Lengyel, B., and Y. Niu, "A YANG Data Model for Factory Default Settings", RFC 8808, DOI 10.17487/RFC8808, August 2020, . [RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based Multiplexed and Secure Transport", RFC 9000, DOI 10.17487/RFC9000, May 2021, . Appendix A. Example of Dynamic Behaviors This section presents some sample data models and corresponding contents of various datastores with different dynamic behaviors described in Section 6. The XML snippets are used only for illustration purposes. Ma, et al. Expires 9 June 2025 [Page 16] Internet-Draft System-defined Configuration December 2024 A.1. Referencing System-defined Nodes In this subsection, the following fictional module is used: module example-application { yang-version 1.1; namespace "urn:example:application"; prefix "ex-app"; import ietf-inet-types { prefix "inet"; } container applications { list application { key "name"; leaf name { type string; } leaf app-id { type string; } leaf protocol { type enumeration { enum tcp; enum udp; } mandatory true; } leaf destination-port { default "0"; type inet:port-number; } leaf description { type string; } container security-protection { presence "Indicates that security protection is enabled."; leaf risk-level { type enumeration { enum high; enum low; } } //additional leafs for security-specific configuration... } } } } Ma, et al. Expires 9 June 2025 [Page 17] Internet-Draft System-defined Configuration December 2024 A fictional ACL YANG module is used as follows, which defines a leafref for the leaf-list "application" data node to refer to an existing application name. module example-acl { yang-version 1.1; namespace "urn:example:acl"; prefix "ex-acl"; import example-application { prefix "ex-app"; } import ietf-inet-types { prefix "inet"; } container acl { list acl-rule { key "name"; leaf name { type string; } container matches { choice l3 { container ipv4 { leaf src-address { type inet:ipv4-prefix; } leaf dst-address { type inet:ipv4-prefix; } } } choice applications { leaf-list application { type leafref { path "/ex-app:applications/ex-app:application" + "/ex-app:name"; } } } } leaf packet-action { type enumeration { enum forward; enum drop; enum redirect; Ma, et al. Expires 9 June 2025 [Page 18] Internet-Draft System-defined Configuration December 2024 } } } } } The server may predefine some applications as a convenience for clients, these applications are immediately-present system configuration. When the device is powered on, the system- instantiated application entries may be present in as follows: ftp 001 tcp 21 low tftp 002 udp 69 low smtp 003 tcp 25 low The client may also define its customized applications. Suppose the configuration of applications is present in as follows: Ma, et al. Expires 9 June 2025 [Page 19] Internet-Draft System-defined Configuration December 2024 my-smtp 101 tcp 2345 customized smtp application high my-foo 102 udp 69 customized application If a client configures an ACL rule referencing some system-provided or customized applications, the configuration of ACL rule may be shown as follows: allow-access-to-ftp-tftp 198.51.100.0/24 192.0.2.0/24 ftp tftp my-smtp forward As different entries of application configuration in and is merged to create , might contain the configuration of applications as follows: Ma, et al. Expires 9 June 2025 [Page 20] Internet-Draft System-defined Configuration December 2024 my-smtp 101 tcp 2345 customized smtp application high my-foo 102 udp 69 customized application ftp 001 tcp 21 low tftp 002 udp 69 low smtp 003 tcp 25 low Ma, et al. Expires 9 June 2025 [Page 21] Internet-Draft System-defined Configuration December 2024 A.2. Modifying a System-instantiated Leaf's Value This subsection uses the following fictional interface YANG module: module example-interface { yang-version 1.1; namespace "urn:example:interface"; prefix "ex-if"; import ietf-inet-types { prefix "inet"; } container interfaces { list interface { key name; leaf name { type string; } leaf description { type string; } leaf mtu { type uint32; } leaf-list ip-address { type inet:ip-address; } } } } Suppose the system provides an immediately-present loopback interface (named "lo0") with a MTU value "65536", a default IPv4 address of "127.0.0.1", and a default IPv6 address of "::1". The configuration of "lo0" interface is present in as follows: lo0 65536 127.0.0.1 ::1 Ma, et al. Expires 9 June 2025 [Page 22] Internet-Draft System-defined Configuration December 2024 A client modifies the value of MTU to 9216 and adds the following configuration into using a "merge" operation: lo0 9216 Then the configuration of interfaces is present in as follows: lo0 9216 127.0.0.1 ::1 A.3. Configuring Descendant Nodes of a System-defined Node In the above example, imagine the client further configures the description node of a "lo0" interface in using a "merge" operation as follows: lo0 loopback The configuration of interface "lo0" is present in as follows: Ma, et al. Expires 9 June 2025 [Page 23] Internet-Draft System-defined Configuration December 2024 lo0 loopback 9216 127.0.0.1 ::1 Appendix B. Key Use Cases This section provides three use cases related to how interacts with other datastores (e.g., , , , and ). The following fictional interface data model is used: Ma, et al. Expires 9 June 2025 [Page 24] Internet-Draft System-defined Configuration December 2024 module example-interface-management { yang-version 1.1; namespace "urn:example:interfacemgmt"; prefix "ex-ifm"; import ietf-inet-types { prefix "inet"; } container interfaces { list interface { key "name"; leaf name { type string; } leaf type { type enumeration { enum ethernet; enum atm; enum loopback; } } leaf enabled { type boolean; default "true"; } leaf-list ip-address { type inet:ip-address; } leaf speed { when "../type = 'ethernet'"; type enumeration { enum 10Mb; enum 100Mb; } } leaf description { type string; } } } } For each use case, corresponding sample configuration in , , and are shown. The XML snippets are used only for illustration purposes. Ma, et al. Expires 9 June 2025 [Page 25] Internet-Draft System-defined Configuration December 2024 B.1. Device Powers On When the device is powered on, suppose the system provides an immediately-present loopback interface (named "lo0") which is not explicitly configured in . Thus, no configuration for interfaces appears in ; And the contents of are: lo0 loopback 127.0.0.1 ::1 system-defined interface In this case, the configuration of loopback interface is only present in , the configuration of interface in would be identical to the one in shown above. And will show the system-provided loopback interface, note that also includes the default value specified in the YANG module: lo0 loopback true 127.0.0.1 ::1 system-defined interface B.2. Client Commits Configuration If a client creates an interface "et-0/0/0" but the interface does not physically exist at this point, what is in appears as follows: Ma, et al. Expires 9 June 2025 [Page 26] Internet-Draft System-defined Configuration December 2024 et-0/0/0 192.168.10.10 pre-provisioned interface And the contents of keep unchanged since the interface is not physically present: lo0 loopback 127.0.0.1 ::1 system-defined interface The contents of represent the merged data of and : lo0 loopback 127.0.0.1 ::1 system-defined interface et-0/0/0 192.168.10.10 pre-provisioned interface Since the interface named "et-0/0/0" does not exist, the associated configuration is not present in , which appears as follows: Ma, et al. Expires 9 June 2025 [Page 27] Internet-Draft System-defined Configuration December 2024 lo0 loopback true 127.0.0.1 ::1 system-defined interface B.3. Operator Installs Card into a Chassis When the interface is installed by the operator, the system will detect it and generate the associated conditionally-present interface configuration in . The contents of keep unchanged: et-0/0/0 192.168.10.10 pre-provisioned interface And might appear as follows: lo0 loopback 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet system-defined interface Then contains the merged configuration of and : Ma, et al. Expires 9 June 2025 [Page 28] Internet-Draft System-defined Configuration December 2024 lo0 loopback 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet 192.168.10.10 pre-provisioned interface And the contents of appear as follows: lo0 loopback true 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet true 192.168.10.10 pre-provisioned interface B.4. Client further Commits Configuration If the client further sets the speed of interface "et-0/0/0" in using a "merge" operation: Ma, et al. Expires 9 June 2025 [Page 29] Internet-Draft System-defined Configuration December 2024 et-0/0/0 10Mb The contents of keep unchanged: lo0 loopback 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet system-defined interface And the contents of which represents a merged results of and are as follows: lo0 loopback 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet 192.168.10.10 10Mb pre-provisioned interface And would appear as follows: Ma, et al. Expires 9 June 2025 [Page 30] Internet-Draft System-defined Configuration December 2024 lo0 loopback true 127.0.0.1 ::1 system-defined interface et-0/0/0 ethernet true 192.168.10.10 10Mb pre-provisioned interface Acknowledgements The authors would like to thank for following for discussions and providing input to this document: Balazs Lengyel, Robert Wilton, Juergen Schoenwaelder, Andy Bierman, Martin Bjorklund, Mohamed Boucadair, Michal Vaško, Alexander Clemm, and Timothy Carey. Contributors Kent Watsen Watsen Networks Email: kent+ietf@watsen.net Jan Lindblad Cisco Systems Email: jlindbla@cisco.com Jason Sterne Nokia Email: jason.sterne@nokia.com Chongfeng Xie China Telecom Beijing China Email: xiechf@chinatelecom.cn Ma, et al. Expires 9 June 2025 [Page 31] Internet-Draft System-defined Configuration December 2024 Authors' Addresses Qiufang Ma (editor) Huawei 101 Software Avenue, Yuhua District Nanjing Jiangsu, 210012 China Email: maqiufang1@huawei.com Qin Wu Huawei 101 Software Avenue, Yuhua District Nanjing Jiangsu, 210012 China Email: bill.wu@huawei.com Chong Feng Email: fengchongllly@gmail.com Ma, et al. Expires 9 June 2025 [Page 32]