-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathdraft-ietf-netmod-system-config-11.txt
1792 lines (1200 loc) · 54.4 KB
/
draft-ietf-netmod-system-config-11.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
NETMOD Q. Ma, Ed.
Internet-Draft Q. Wu
Updates: 8342 (if approved) Huawei
Intended status: Standards Track C. Feng
Expires: 11 July 2025 7 January 2025
System-defined Configuration
draft-ietf-netmod-system-config-11
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 11 July 2025.
Copyright Notice
Copyright (c) 2025 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 11 July 2025 [Page 1]
Internet-Draft System-defined Configuration January 2025
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 . . . . . . . . . . . . . . . . . . 4
1.3. Updates to RFC 8342 . . . . . . . . . . . . . . . . . . . 5
2. Kinds of System Configuration . . . . . . . . . . . . . . . . 5
2.1. Always-Present . . . . . . . . . . . . . . . . . . . . . 5
2.2. Conditionally-Present . . . . . . . . . . . . . . . . . . 6
3. The System Configuration Datastore (<system>) . . . . . . . . 6
4. Conceptual Model of Datastores . . . . . . . . . . . . . . . 7
5. Static Characteristics . . . . . . . . . . . . . . . . . . . 9
5.1. Read-only to Clients . . . . . . . . . . . . . . . . . . 9
5.2. No Impact to <operational> . . . . . . . . . . . . . . . 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 . . 10
7. Relationships to Other Datastores . . . . . . . . . . . . . . 10
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 . . . . . . . . . . . . . . . . . . . 13
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 . . . . . . . . . . . . 16
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 11 July 2025 [Page 2]
Internet-Draft System-defined Configuration January 2025
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 <operational> 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, whose
existence in the system configuration is tied to the presence of
particular hardware, 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
<system>, 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: RFC 8342 defines it as "Configuration that is
Ma, et al. Expires 11 July 2025 [Page 3]
Internet-Draft System-defined Configuration January 2025
supplied by the device itself." The current definition expands on
the definition from [RFC8342] that system configuration is present
in the system configuration datastore (regardless of whether it is
applied or referenced). It 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 "<system>".
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: <running>, <startup>, <candidate>,
<system>, and <intended>. 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.
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.
Ma, et al. Expires 11 July 2025 [Page 4]
Internet-Draft System-defined Configuration January 2025
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 <running> is merged with <system> to create the
contents of <intended> 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 <intended>, this
document updates its definition as the origin source of configuration
explicitly provided by clients, and allows a subset of configuration
in <intended> that flows from <system> yet is not configured or
overridden explicitly in <running> to use "system" as its origin
value. All configuration nodes in <operational> with origin "system"
MUST originate from <system>. Configuration copied from <system>
into <running> has its origin value reported as "intended" when it
flows into <operational>.
2. Kinds of System Configuration
This document defines two types of system configuration.
Configuration that is always-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. Always-Present
Always-present refers to system configuration which is generated in
<system> when the device is powered on, irrespective of physical
resource present or not, a special functionality enabled or not. An
example of always-present system configuration is an always-existing
loopback interface.
Ma, et al. Expires 11 July 2025 [Page 5]
Internet-Draft System-defined Configuration January 2025
2.2. Conditionally-Present
Conditionally-present refers to system configuration which is
generated in <system> 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 the associated configuration; when the physical resource is not
present (an interface card is removed), the system configuration will
automatically be removed from <system>. 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 (<system>)
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 <intended>.
* 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 11 July 2025 [Page 6]
Internet-Draft System-defined Configuration January 2025
4. Conceptual Model of Datastores
Clients may provide configuration nodes that reference nodes defined
in <system>, override system-provided values, and configure
descendant nodes of system-defined configuration in <running>, as
detailed in Section 6.
To ensure the validity of <intended>, configuration in <running> is
merged with <system> to become <intended>, in which process,
configuration appearing in <running> takes precedence over the same
node in <system>. Since it is unspecified how to merge configuration
before transformations, if <system> or <running> 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 <running> is merged with <system>.
Whenever configuration in <system> changes, the server MUST also
immediately update and validate <intended>.
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 11 July 2025 [Page 7]
Internet-Draft System-defined Configuration January 2025
+-------------+ +-----------+
| <candidate> | | <startup> |
| (ct, rw) |<---+ +---->| (ct, rw) |
+-------------+ | | +-----------+
| | | |
+-----------+ | +-----------+ |
| <system> | +------->| <running> |<--------+
| (ct, ro) | | (ct, rw) |
+-----------+ +-----------+
| |
| |
| | // configuration transformations,
+--------------+---------------+ // e.g., removal of nodes marked
| // as "inactive", expansion of
| // templates
v
+------------+
| <intended> | // 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
+---------------+
| <operational> | <-- 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 11 July 2025 [Page 8]
Internet-Draft System-defined Configuration January 2025
Configuration in <system> is undeletable to clients (e.g., a system-
defined list entry can never be removed), even though a node defined
in <system> may be overridden in <running>. If it is desired to
enable a client to delete system configuration, it can be
approximated using <factory-default>, 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 <running>
(Section 6.3), the node in <running> may be removed later, in which
case system-initialized value defined in <system> may still be in use
and appear in <operational>.
5. Static Characteristics
5.1. Read-only to Clients
The system datastore is read-only (i.e., edits towards <system>
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 <operational>
This work has no impact to <operational>. 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]. <system>
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 <operational>. "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 <system> 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].
If system configuration changes, <running> SHOULD remain accurate and
consistent with <system>. However, any mechanism for handling these
circumstances is outside the scope of this document.
Ma, et al. Expires 11 July 2025 [Page 9]
Internet-Draft System-defined Configuration January 2025
6.2. Referencing System Configuration
Clients may create configuration data in <running> that references
nodes in <system>. 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
<running> that overrides the values of matched configuration nodes at
the corresponding level in <system>. Configurations defined in
<running> take precedence over system configuration nodes in <system>
if the server allows the nodes to be modified (some implementations
may have immutable system configuration as per
[I-D.ietf-netmod-immutable-flag]).
Appendix A.2 provides an example of a client overriding a system-
instantiated leaf's value.
6.4. Configuring Descendant nodes of System Configuration
A server may also allow a client to add nodes to a list entry in
<system> by writing those additional nodes in <running>. Those
additional data nodes may not exist in <system> (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 <system> to
other datastores known at the time of this writing.
Ma, et al. Expires 11 July 2025 [Page 10]
Internet-Draft System-defined Configuration January 2025
7.1. The "factory-default" Datastore
The "factory-default" datastore defined in [RFC8808] is used to
initialize <running> when the device is first-time powered on or
reset to its factory default condition. If a <factory-default> is
supported on a server, any deletable system-provided configuration
that is populated as part of <running> by the system at boot up,
without being part of the contents of <startup>, must be defined in
<factory-default>. Otherwise, deletable system configuration could
be provided as the initial contents of <startup> as an alternative.
The <factory-reset> RPC operation can reset <system> 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:
Identities:
+--- datastore
| +--- conventional
| | +--- running
| | +--- candidate
| | +--- startup
| | +--- system
| | +--- intended
| +--- dynamic
| +--- operational
The diagram above uses syntax that is similar to but not defined in
[RFC8340].
Ma, et al. Expires 11 July 2025 [Page 11]
Internet-Draft System-defined Configuration January 2025
8.2. YANG Module
<CODE BEGINS> file "[email protected]"
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 <mailto:[email protected]>
Author: Qiufang Ma
<mailto:[email protected]>
Author: Qin Wu
<mailto:[email protected]>
Author: Chong Feng
<mailto:[email protected]>";
description
"This module defines a new YANG identity that uses the
ds:conventional identity defined in [RFC8342].
Copyright (c) 2025 IETF Trust and the persons identified
as authors of the code. All rights reserved.
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 2025-01-07 {
description
"Initial version.";
Ma, et al. Expires 11 July 2025 [Page 12]
Internet-Draft System-defined Configuration January 2025
reference
"RFC XXXX: System-defined Configuration";
}
identity system {
base ds:conventional;
description
"This read-only datastore contains the configuration
provided by the system itself.";
}
}
<CODE ENDS>
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].
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.
Ma, et al. Expires 11 July 2025 [Page 13]
Internet-Draft System-defined Configuration January 2025
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,
<https://www.rfc-editor.org/info/rfc2119>.
[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,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[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,
<https://www.rfc-editor.org/info/rfc8342>.
[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,
<https://www.rfc-editor.org/info/rfc8639>.
Ma, et al. Expires 11 July 2025 [Page 14]
Internet-Draft System-defined Configuration January 2025
[RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications
for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641,
September 2019, <https://www.rfc-editor.org/info/rfc8641>.
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, <https://datatracker.ietf.org/doc/html/
draft-ietf-netmod-immutable-flag-02>.
[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,
<https://datatracker.ietf.org/doc/html/draft-ietf-netmod-
rfc8407bis-21>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252,
January 2006, <https://www.rfc-editor.org/info/rfc4252>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC7952] Lhotka, L., "Defining and Using Metadata with YANG",
RFC 7952, DOI 10.17487/RFC7952, August 2016,
<https://www.rfc-editor.org/info/rfc7952>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
Ma, et al. Expires 11 July 2025 [Page 15]
Internet-Draft System-defined Configuration January 2025
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Documents Containing YANG Data Models", BCP 216, RFC 8407,
DOI 10.17487/RFC8407, October 2018,
<https://www.rfc-editor.org/info/rfc8407>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
and R. Wilton, "YANG Library", RFC 8525,
DOI 10.17487/RFC8525, March 2019,
<https://www.rfc-editor.org/info/rfc8525>.
[RFC8808] Wu, Q., Lengyel, B., and Y. Niu, "A YANG Data Model for
Factory Default Settings", RFC 8808, DOI 10.17487/RFC8808,
August 2020, <https://www.rfc-editor.org/info/rfc8808>.
[RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based
Multiplexed and Secure Transport", RFC 9000,
DOI 10.17487/RFC9000, May 2021,
<https://www.rfc-editor.org/info/rfc9000>.
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.
A.1. Referencing System-defined Nodes
In this subsection, the following fictional module is used:
Ma, et al. Expires 11 July 2025 [Page 16]
Internet-Draft System-defined Configuration January 2025
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...
}
}
}
}
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.
Ma, et al. Expires 11 July 2025 [Page 17]
Internet-Draft System-defined Configuration January 2025
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;