Debian Codegraph @

rfc8819.html

raw
1 <!DOCTYPE html>
2 <html lang="en" class="RFC">
3 <head>
4 <meta charset="utf-8">
5 <meta content="Common,Latin" name="scripts">
6 <meta content="initial-scale=1.0" name="viewport">
7 <title>RFC 8819: YANG Module Tags</title>
8 <meta content="Christian Hopps" name="author">
9 <meta content="Lou Berger" name="author">
10 <meta content="Dean Bogdanovic" name="author">
11 <meta content="
12 This document provides for the association of tags with YANG
13 modules. The expectation is for such tags to be used to help classify
14 and organize modules. A method for defining, reading, and writing
15 modules tags is provided. Tags may be registered and assigned during
16 module definition, assigned by implementations, or dynamically defined
17 and set by users. This document also provides guidance to future model
18 writers; as such, this document updates RFC 8407.
19 " name="description">
20 <meta content="xml2rfc 3.5.0" name="generator">
21 <meta content="YANG" name="keyword">
22 <meta content="tags" name="keyword">
23 <meta content="8819" name="rfc.number">
24 <!-- Generator version information:
25 xml2rfc 3.5.0
26 Python 3.6.10
27 appdirs 1.4.4
28 ConfigArgParse 1.2.3
29 google-i18n-address 2.3.5
30 html5lib 1.0.1
31 intervaltree 3.0.2
32 Jinja2 2.11.2
33 kitchen 1.2.6
34 lxml 4.4.2
35 pycairo 1.19.0
36 pycountry 19.8.18
37 pyflakes 2.1.1
38 PyYAML 5.3.1
39 requests 2.22.0
40 setuptools 40.6.2
41 six 1.14.0
42 WeasyPrint 51
43 -->
44 <link href="rfc8819.xml" rel="alternate" type="application/rfc+xml">
45 <link href="#copyright" rel="license">
46 <style type="text/css">/*
47
48 NOTE: Changes at the bottom of this file overrides some earlier settings.
49
50 Once the style has stabilized and has been adopted as an official RFC style,
51 this can be consolidated so that style settings occur only in one place, but
52 for now the contents of this file consists first of the initial CSS work as
53 provided to the RFC Formatter (xml2rfc) work, followed by itemized and
54 commented changes found necssary during the development of the v3
55 formatters.
56
57 */
58
59 /* fonts */
60 @import url('https://fonts.googleapis.com/css?family=Noto+Sans'); /* Sans-serif */
61 @import url('https://fonts.googleapis.com/css?family=Noto+Serif'); /* Serif (print) */
62 @import url('https://fonts.googleapis.com/css?family=Roboto+Mono'); /* Monospace */
63
64 @viewport {
65 zoom: 1.0;
66 width: extend-to-zoom;
67 }
68 @-ms-viewport {
69 width: extend-to-zoom;
70 zoom: 1.0;
71 }
72 /* general and mobile first */
73 html {
74 }
75 body {
76 max-width: 90%;
77 margin: 1.5em auto;
78 color: #222;
79 background-color: #fff;
80 font-size: 14px;
81 font-family: 'Noto Sans', Arial, Helvetica, sans-serif;
82 line-height: 1.6;
83 scroll-behavior: smooth;
84 }
85 .ears {
86 display: none;
87 }
88
89 /* headings */
90 #title, h1, h2, h3, h4, h5, h6 {
91 margin: 1em 0 0.5em;
92 font-weight: bold;
93 line-height: 1.3;
94 }
95 #title {
96 clear: both;
97 border-bottom: 1px solid #ddd;
98 margin: 0 0 0.5em 0;
99 padding: 1em 0 0.5em;
100 }
101 .author {
102 padding-bottom: 4px;
103 }
104 h1 {
105 font-size: 26px;
106 margin: 1em 0;
107 }
108 h2 {
109 font-size: 22px;
110 margin-top: -20px; /* provide offset for in-page anchors */
111 padding-top: 33px;
112 }
113 h3 {
114 font-size: 18px;
115 margin-top: -36px; /* provide offset for in-page anchors */
116 padding-top: 42px;
117 }
118 h4 {
119 font-size: 16px;
120 margin-top: -36px; /* provide offset for in-page anchors */
121 padding-top: 42px;
122 }
123 h5, h6 {
124 font-size: 14px;
125 }
126 #n-copyright-notice {
127 border-bottom: 1px solid #ddd;
128 padding-bottom: 1em;
129 margin-bottom: 1em;
130 }
131 /* general structure */
132 p {
133 padding: 0;
134 margin: 0 0 1em 0;
135 text-align: left;
136 }
137 div, span {
138 position: relative;
139 }
140 div {
141 margin: 0;
142 }
143 .alignRight.art-text {
144 background-color: #f9f9f9;
145 border: 1px solid #eee;
146 border-radius: 3px;
147 padding: 1em 1em 0;
148 margin-bottom: 1.5em;
149 }
150 .alignRight.art-text pre {
151 padding: 0;
152 }
153 .alignRight {
154 margin: 1em 0;
155 }
156 .alignRight > *:first-child {
157 border: none;
158 margin: 0;
159 float: right;
160 clear: both;
161 }
162 .alignRight > *:nth-child(2) {
163 clear: both;
164 display: block;
165 border: none;
166 }
167 svg {
168 display: block;
169 }
170 .alignCenter.art-text {
171 background-color: #f9f9f9;
172 border: 1px solid #eee;
173 border-radius: 3px;
174 padding: 1em 1em 0;
175 margin-bottom: 1.5em;
176 }
177 .alignCenter.art-text pre {
178 padding: 0;
179 }
180 .alignCenter {
181 margin: 1em 0;
182 }
183 .alignCenter > *:first-child {
184 border: none;
185 /* this isn't optimal, but it's an existence proof. PrinceXML doesn't
186 support flexbox yet.
187 */
188 display: table;
189 margin: 0 auto;
190 }
191
192 /* lists */
193 ol, ul {
194 padding: 0;
195 margin: 0 0 1em 2em;
196 }
197 ol ol, ul ul, ol ul, ul ol {
198 margin-left: 1em;
199 }
200 li {
201 margin: 0 0 0.25em 0;
202 }
203 .ulCompact li {
204 margin: 0;
205 }
206 ul.empty, .ulEmpty {
207 list-style-type: none;
208 }
209 ul.empty li, .ulEmpty li {
210 margin-top: 0.5em;
211 }
212 ul.compact, .ulCompact,
213 ol.compact, .olCompact {
214 line-height: 100%;
215 margin: 0 0 0 2em;
216 }
217
218 /* definition lists */
219 dl {
220 }
221 dl > dt {
222 float: left;
223 margin-right: 1em;
224 }
225 /*
226 dl.nohang > dt {
227 float: none;
228 }
229 */
230 dl > dd {
231 margin-bottom: .8em;
232 min-height: 1.3em;
233 }
234 dl.compact > dd, .dlCompact > dd {
235 margin-bottom: 0em;
236 }
237 dl > dd > dl {
238 margin-top: 0.5em;
239 margin-bottom: 0em;
240 }
241
242 /* links */
243 a {
244 text-decoration: none;
245 }
246 a[href] {
247 color: #22e; /* Arlen: WCAG 2019 */
248 }
249 a[href]:hover {
250 background-color: #f2f2f2;
251 }
252 figcaption a[href],
253 a[href].selfRef {
254 color: #222;
255 }
256 /* XXX probably not this:
257 a.selfRef:hover {
258 background-color: transparent;
259 cursor: default;
260 } */
261
262 /* Figures */
263 tt, code, pre, code {
264 background-color: #f9f9f9;
265 font-family: 'Roboto Mono', monospace;
266 }
267 pre {
268 border: 1px solid #eee;
269 margin: 0;
270 padding: 1em;
271 }
272 img {
273 max-width: 100%;
274 }
275 figure {
276 margin: 0;
277 }
278 figure blockquote {
279 margin: 0.8em 0.4em 0.4em;
280 }
281 figcaption {
282 font-style: italic;
283 margin: 0 0 1em 0;
284 }
285 @media screen {
286 pre {
287 overflow-x: auto;
288 max-width: 100%;
289 max-width: calc(100% - 22px);
290 }
291 }
292
293 /* aside, blockquote */
294 aside, blockquote {
295 margin-left: 0;
296 padding: 1.2em 2em;
297 }
298 blockquote {
299 background-color: #f9f9f9;
300 color: #111; /* Arlen: WCAG 2019 */
301 border: 1px solid #ddd;
302 border-radius: 3px;
303 margin: 1em 0;
304 }
305 cite {
306 display: block;
307 text-align: right;
308 font-style: italic;
309 }
310
311 /* tables */
312 table {
313 width: 100%;
314 margin: 0 0 1em;
315 border-collapse: collapse;
316 border: 1px solid #eee;
317 }
318 th, td {
319 text-align: left;
320 vertical-align: top;
321 padding: 0.5em 0.75em;
322 }
323 th {
324 text-align: left;
325 background-color: #e9e9e9;
326 }
327 tr:nth-child(2n+1) > td {
328 background-color: #f5f5f5;
329 }
330 table caption {
331 font-style: italic;
332 margin: 0;
333 padding: 0;
334 text-align: left;
335 }
336 table p {
337 /* XXX to avoid bottom margin on table row signifiers. If paragraphs should
338 be allowed within tables more generally, it would be far better to select on a class. */
339 margin: 0;
340 }
341
342 /* pilcrow */
343 a.pilcrow {
344 color: #666; /* Arlen: AHDJ 2019 */
345 text-decoration: none;
346 visibility: hidden;
347 user-select: none;
348 -ms-user-select: none;
349 -o-user-select:none;
350 -moz-user-select: none;
351 -khtml-user-select: none;
352 -webkit-user-select: none;
353 -webkit-touch-callout: none;
354 }
355 @media screen {
356 aside:hover > a.pilcrow,
357 p:hover > a.pilcrow,
358 blockquote:hover > a.pilcrow,
359 div:hover > a.pilcrow,
360 li:hover > a.pilcrow,
361 pre:hover > a.pilcrow {
362 visibility: visible;
363 }
364 a.pilcrow:hover {
365 background-color: transparent;
366 }
367 }
368
369 /* misc */
370 hr {
371 border: 0;
372 border-top: 1px solid #eee;
373 }
374 .bcp14 {
375 font-variant: small-caps;
376 }
377
378 .role {
379 font-variant: all-small-caps;
380 }
381
382 /* info block */
383 #identifiers {
384 margin: 0;
385 font-size: 0.9em;
386 }
387 #identifiers dt {
388 width: 3em;
389 clear: left;
390 }
391 #identifiers dd {
392 float: left;
393 margin-bottom: 0;
394 }
395 #identifiers .authors .author {
396 display: inline-block;
397 margin-right: 1.5em;
398 }
399 #identifiers .authors .org {
400 font-style: italic;
401 }
402
403 /* The prepared/rendered info at the very bottom of the page */
404 .docInfo {
405 color: #666; /* Arlen: WCAG 2019 */
406 font-size: 0.9em;
407 font-style: italic;
408 margin-top: 2em;
409 }
410 .docInfo .prepared {
411 float: left;
412 }
413 .docInfo .prepared {
414 float: right;
415 }
416
417 /* table of contents */
418 #toc {
419 padding: 0.75em 0 2em 0;
420 margin-bottom: 1em;
421 }
422 nav.toc ul {
423 margin: 0 0.5em 0 0;
424 padding: 0;
425 list-style: none;
426 }
427 nav.toc li {
428 line-height: 1.3em;
429 margin: 0.75em 0;
430 padding-left: 1.2em;
431 text-indent: -1.2em;
432 }
433 /* references */
434 .references dt {
435 text-align: right;
436 font-weight: bold;
437 min-width: 7em;
438 }
439 .references dd {
440 margin-left: 8em;
441 overflow: auto;
442 }
443
444 .refInstance {
445 margin-bottom: 1.25em;
446 }
447
448 .references .ascii {
449 margin-bottom: 0.25em;
450 }
451
452 /* index */
453 .index ul {
454 margin: 0 0 0 1em;
455 padding: 0;
456 list-style: none;
457 }
458 .index ul ul {
459 margin: 0;
460 }
461 .index li {
462 margin: 0;
463 text-indent: -2em;
464 padding-left: 2em;
465 padding-bottom: 5px;
466 }
467 .indexIndex {
468 margin: 0.5em 0 1em;
469 }
470 .index a {
471 font-weight: 700;
472 }
473 /* make the index two-column on all but the smallest screens */
474 @media (min-width: 600px) {
475 .index ul {
476 -moz-column-count: 2;
477 -moz-column-gap: 20px;
478 }
479 .index ul ul {
480 -moz-column-count: 1;
481 -moz-column-gap: 0;
482 }
483 }
484
485 /* authors */
486 address.vcard {
487 font-style: normal;
488 margin: 1em 0;
489 }
490
491 address.vcard .nameRole {
492 font-weight: 700;
493 margin-left: 0;
494 }
495 address.vcard .label {
496 font-family: "Noto Sans",Arial,Helvetica,sans-serif;
497 margin: 0.5em 0;
498 }
499 address.vcard .type {
500 display: none;
501 }
502 .alternative-contact {
503 margin: 1.5em 0 1em;
504 }
505 hr.addr {
506 border-top: 1px dashed;
507 margin: 0;
508 color: #ddd;
509 max-width: calc(100% - 16px);
510 }
511
512 /* temporary notes */
513 .rfcEditorRemove::before {
514 position: absolute;
515 top: 0.2em;
516 right: 0.2em;
517 padding: 0.2em;
518 content: "The RFC Editor will remove this note";
519 color: #9e2a00; /* Arlen: WCAG 2019 */
520 background-color: #ffd; /* Arlen: WCAG 2019 */
521 }
522 .rfcEditorRemove {
523 position: relative;
524 padding-top: 1.8em;
525 background-color: #ffd; /* Arlen: WCAG 2019 */
526 border-radius: 3px;
527 }
528 .cref {
529 background-color: #ffd; /* Arlen: WCAG 2019 */
530 padding: 2px 4px;
531 }
532 .crefSource {
533 font-style: italic;
534 }
535 /* alternative layout for smaller screens */
536 @media screen and (max-width: 1023px) {
537 body {
538 padding-top: 2em;
539 }
540 #title {
541 padding: 1em 0;
542 }
543 h1 {
544 font-size: 24px;
545 }
546 h2 {
547 font-size: 20px;
548 margin-top: -18px; /* provide offset for in-page anchors */
549 padding-top: 38px;
550 }
551 #identifiers dd {
552 max-width: 60%;
553 }
554 #toc {
555 position: fixed;
556 z-index: 2;
557 top: 0;
558 right: 0;
559 padding: 0;
560 margin: 0;
561 background-color: inherit;
562 border-bottom: 1px solid #ccc;
563 }
564 #toc h2 {
565 margin: -1px 0 0 0;
566 padding: 4px 0 4px 6px;
567 padding-right: 1em;
568 min-width: 190px;
569 font-size: 1.1em;
570 text-align: right;
571 background-color: #444;
572 color: white;
573 cursor: pointer;
574 }
575 #toc h2::before { /* css hamburger */
576 float: right;
577 position: relative;
578 width: 1em;
579 height: 1px;
580 left: -164px;
581 margin: 6px 0 0 0;
582 background: white none repeat scroll 0 0;
583 box-shadow: 0 4px 0 0 white, 0 8px 0 0 white;
584 content: "";
585 }
586 #toc nav {
587 display: none;
588 padding: 0.5em 1em 1em;
589 overflow: auto;
590 height: calc(100vh - 48px);
591 border-left: 1px solid #ddd;
592 }
593 }
594
595 /* alternative layout for wide screens */
596 @media screen and (min-width: 1024px) {
597 body {
598 max-width: 724px;
599 margin: 42px auto;
600 padding-left: 1.5em;
601 padding-right: 29em;
602 }
603 #toc {
604 position: fixed;
605 top: 42px;
606 right: 42px;
607 width: 25%;
608 margin: 0;
609 padding: 0 1em;
610 z-index: 1;
611 }
612 #toc h2 {
613 border-top: none;
614 border-bottom: 1px solid #ddd;
615 font-size: 1em;
616 font-weight: normal;
617 margin: 0;
618 padding: 0.25em 1em 1em 0;
619 }
620 #toc nav {
621 display: block;
622 height: calc(90vh - 84px);
623 bottom: 0;
624 padding: 0.5em 0 0;
625 overflow: auto;
626 }
627 img { /* future proofing */
628 max-width: 100%;
629 height: auto;
630 }
631 }
632
633 /* pagination */
634 @media print {
635 body {
636
637 width: 100%;
638 }
639 p {
640 orphans: 3;
641 widows: 3;
642 }
643 #n-copyright-notice {
644 border-bottom: none;
645 }
646 #toc, #n-introduction {
647 page-break-before: always;
648 }
649 #toc {
650 border-top: none;
651 padding-top: 0;
652 }
653 figure, pre {
654 page-break-inside: avoid;
655 }
656 figure {
657 overflow: scroll;
658 }
659 h1, h2, h3, h4, h5, h6 {
660 page-break-after: avoid;
661 }
662 h2+*, h3+*, h4+*, h5+*, h6+* {
663 page-break-before: avoid;
664 }
665 pre {
666 white-space: pre-wrap;
667 word-wrap: break-word;
668 font-size: 10pt;
669 }
670 table {
671 border: 1px solid #ddd;
672 }
673 td {
674 border-top: 1px solid #ddd;
675 }
676 }
677
678 /* This is commented out here, as the string-set: doesn't
679 pass W3C validation currently */
680 /*
681 .ears thead .left {
682 string-set: ears-top-left content();
683 }
684
685 .ears thead .center {
686 string-set: ears-top-center content();
687 }
688
689 .ears thead .right {
690 string-set: ears-top-right content();
691 }
692
693 .ears tfoot .left {
694 string-set: ears-bottom-left content();
695 }
696
697 .ears tfoot .center {
698 string-set: ears-bottom-center content();
699 }
700
701 .ears tfoot .right {
702 string-set: ears-bottom-right content();
703 }
704 */
705
706 @page :first {
707 padding-top: 0;
708 @top-left {
709 content: normal;
710 border: none;
711 }
712 @top-center {
713 content: normal;
714 border: none;
715 }
716 @top-right {
717 content: normal;
718 border: none;
719 }
720 }
721
722 @page {
723 size: A4;
724 margin-bottom: 45mm;
725 padding-top: 20px;
726 /* The follwing is commented out here, but set appropriately by in code, as
727 the content depends on the document */
728 /*
729 @top-left {
730 content: 'Internet-Draft';
731 vertical-align: bottom;
732 border-bottom: solid 1px #ccc;
733 }
734 @top-left {
735 content: string(ears-top-left);
736 vertical-align: bottom;
737 border-bottom: solid 1px #ccc;
738 }
739 @top-center {
740 content: string(ears-top-center);
741 vertical-align: bottom;
742 border-bottom: solid 1px #ccc;
743 }
744 @top-right {
745 content: string(ears-top-right);
746 vertical-align: bottom;
747 border-bottom: solid 1px #ccc;
748 }
749 @bottom-left {
750 content: string(ears-bottom-left);
751 vertical-align: top;
752 border-top: solid 1px #ccc;
753 }
754 @bottom-center {
755 content: string(ears-bottom-center);
756 vertical-align: top;
757 border-top: solid 1px #ccc;
758 }
759 @bottom-right {
760 content: '[Page ' counter(page) ']';
761 vertical-align: top;
762 border-top: solid 1px #ccc;
763 }
764 */
765
766 }
767
768 /* Changes introduced to fix issues found during implementation */
769 /* Make sure links are clickable even if overlapped by following H* */
770 a {
771 z-index: 2;
772 }
773 /* Separate body from document info even without intervening H1 */
774 section {
775 clear: both;
776 }
777
778
779 /* Top align author divs, to avoid names without organization dropping level with org names */
780 .author {
781 vertical-align: top;
782 }
783
784 /* Leave room in document info to show Internet-Draft on one line */
785 #identifiers dt {
786 width: 8em;
787 }
788
789 /* Don't waste quite as much whitespace between label and value in doc info */
790 #identifiers dd {
791 margin-left: 1em;
792 }
793
794 /* Give floating toc a background color (needed when it's a div inside section */
795 #toc {
796 background-color: white;
797 }
798
799 /* Make the collapsed ToC header render white on gray also when it's a link */
800 @media screen and (max-width: 1023px) {
801 #toc h2 a,
802 #toc h2 a:link,
803 #toc h2 a:focus,
804 #toc h2 a:hover,
805 #toc a.toplink,
806 #toc a.toplink:hover {
807 color: white;
808 background-color: #444;
809 text-decoration: none;
810 }
811 }
812
813 /* Give the bottom of the ToC some whitespace */
814 @media screen and (min-width: 1024px) {
815 #toc {
816 padding: 0 0 1em 1em;
817 }
818 }
819
820 /* Style section numbers with more space between number and title */
821 .section-number {
822 padding-right: 0.5em;
823 }
824
825 /* prevent monospace from becoming overly large */
826 tt, code, pre, code {
827 font-size: 95%;
828 }
829
830 /* Fix the height/width aspect for ascii art*/
831 pre.sourcecode,
832 .art-text pre {
833 line-height: 1.12;
834 }
835
836
837 /* Add styling for a link in the ToC that points to the top of the document */
838 a.toplink {
839 float: right;
840 margin-right: 0.5em;
841 }
842
843 /* Fix the dl styling to match the RFC 7992 attributes */
844 dl > dt,
845 dl.dlParallel > dt {
846 float: left;
847 margin-right: 1em;
848 }
849 dl.dlNewline > dt {
850 float: none;
851 }
852
853 /* Provide styling for table cell text alignment */
854 table td.text-left,
855 table th.text-left {
856 text-align: left;
857 }
858 table td.text-center,
859 table th.text-center {
860 text-align: center;
861 }
862 table td.text-right,
863 table th.text-right {
864 text-align: right;
865 }
866
867 /* Make the alternative author contact informatio look less like just another
868 author, and group it closer with the primary author contact information */
869 .alternative-contact {
870 margin: 0.5em 0 0.25em 0;
871 }
872 address .non-ascii {
873 margin: 0 0 0 2em;
874 }
875
876 /* With it being possible to set tables with alignment
877 left, center, and right, { width: 100%; } does not make sense */
878 table {
879 width: auto;
880 }
881
882 /* Avoid reference text that sits in a block with very wide left margin,
883 because of a long floating dt label.*/
884 .references dd {
885 overflow: visible;
886 }
887
888 /* Control caption placement */
889 caption {
890 caption-side: bottom;
891 }
892
893 /* Limit the width of the author address vcard, so names in right-to-left
894 script don't end up on the other side of the page. */
895
896 address.vcard {
897 max-width: 30em;
898 margin-right: auto;
899 }
900
901 /* For address alignment dependent on LTR or RTL scripts */
902 address div.left {
903 text-align: left;
904 }
905 address div.right {
906 text-align: right;
907 }
908
909 /* Provide table alignment support. We can't use the alignX classes above
910 since they do unwanted things with caption and other styling. */
911 table.right {
912 margin-left: auto;
913 margin-right: 0;
914 }
915 table.center {
916 margin-left: auto;
917 margin-right: auto;
918 }
919 table.left {
920 margin-left: 0;
921 margin-right: auto;
922 }
923
924 /* Give the table caption label the same styling as the figcaption */
925 caption a[href] {
926 color: #222;
927 }
928
929 @media print {
930 .toplink {
931 display: none;
932 }
933
934 /* avoid overwriting the top border line with the ToC header */
935 #toc {
936 padding-top: 1px;
937 }
938
939 /* Avoid page breaks inside dl and author address entries */
940 .vcard {
941 page-break-inside: avoid;
942 }
943
944 }
945 /* Tweak the bcp14 keyword presentation */
946 .bcp14 {
947 font-variant: small-caps;
948 font-weight: bold;
949 font-size: 0.9em;
950 }
951 /* Tweak the invisible space above H* in order not to overlay links in text above */
952 h2 {
953 margin-top: -18px; /* provide offset for in-page anchors */
954 padding-top: 31px;
955 }
956 h3 {
957 margin-top: -18px; /* provide offset for in-page anchors */
958 padding-top: 24px;
959 }
960 h4 {
961 margin-top: -18px; /* provide offset for in-page anchors */
962 padding-top: 24px;
963 }
964 /* Float artwork pilcrow to the right */
965 @media screen {
966 .artwork a.pilcrow {
967 display: block;
968 line-height: 0.7;
969 margin-top: 0.15em;
970 }
971 }
972 /* Make pilcrows on dd visible */
973 @media screen {
974 dd:hover > a.pilcrow {
975 visibility: visible;
976 }
977 }
978 /* Make the placement of figcaption match that of a table's caption
979 by removing the figure's added bottom margin */
980 .alignLeft.art-text,
981 .alignCenter.art-text,
982 .alignRight.art-text {
983 margin-bottom: 0;
984 }
985 .alignLeft,
986 .alignCenter,
987 .alignRight {
988 margin: 1em 0 0 0;
989 }
990 /* In print, the pilcrow won't show on hover, so prevent it from taking up space,
991 possibly even requiring a new line */
992 @media print {
993 a.pilcrow {
994 display: none;
995 }
996 }
997 /* Styling for the external metadata */
998 div#external-metadata {
999 background-color: #eee;
1000 padding: 0.5em;
1001 margin-bottom: 0.5em;
1002 display: none;
1003 }
1004 div#internal-metadata {
1005 padding: 0.5em; /* to match the external-metadata padding */
1006 }
1007 /* Styling for title RFC Number */
1008 h1#rfcnum {
1009 clear: both;
1010 margin: 0 0 -1em;
1011 padding: 1em 0 0 0;
1012 }
1013 /* Make .olPercent look the same as <ol><li> */
1014 dl.olPercent > dd {
1015 margin-bottom: 0.25em;
1016 min-height: initial;
1017 }
1018 /* Give aside some styling to set it apart */
1019 aside {
1020 border-left: 1px solid #ddd;
1021 margin: 1em 0 1em 2em;
1022 padding: 0.2em 2em;
1023 }
1024 aside > dl,
1025 aside > ol,
1026 aside > ul,
1027 aside > table,
1028 aside > p {
1029 margin-bottom: 0.5em;
1030 }
1031 /* Additional page break settings */
1032 @media print {
1033 figcaption, table caption {
1034 page-break-before: avoid;
1035 }
1036 }
1037 /* Font size adjustments for print */
1038 @media print {
1039 body { font-size: 10pt; line-height: normal; max-width: 96%; }
1040 h1 { font-size: 1.72em; padding-top: 1.5em; } /* 1*1.2*1.2*1.2 */
1041 h2 { font-size: 1.44em; padding-top: 1.5em; } /* 1*1.2*1.2 */
1042 h3 { font-size: 1.2em; padding-top: 1.5em; } /* 1*1.2 */
1043 h4 { font-size: 1em; padding-top: 1.5em; }
1044 h5, h6 { font-size: 1em; margin: initial; padding: 0.5em 0 0.3em; }
1045 }
1046 /* Sourcecode margin in print, when there's no pilcrow */
1047 @media print {
1048 .artwork,
1049 .sourcecode {
1050 margin-bottom: 1em;
1051 }
1052 }
1053 /* Avoid narrow tables forcing too narrow table captions, which may render badly */
1054 table {
1055 min-width: 20em;
1056 }
1057 /* ol type a */
1058 ol.type-a { list-style-type: lower-alpha; }
1059 ol.type-A { list-style-type: upper-alpha; }
1060 ol.type-i { list-style-type: lower-roman; }
1061 ol.type-I { list-style-type: lower-roman; }
1062 /* Apply the print table and row borders in general, on request from the RPC,
1063 and increase the contrast between border and odd row background sligthtly */
1064 table {
1065 border: 1px solid #ddd;
1066 }
1067 td {
1068 border-top: 1px solid #ddd;
1069 }
1070 tr:nth-child(2n+1) > td {
1071 background-color: #f8f8f8;
1072 }
1073 /* Use style rules to govern display of the TOC. */
1074 @media screen and (max-width: 1023px) {
1075 #toc nav { display: none; }
1076 #toc.active nav { display: block; }
1077 }
1078 /* Add support for keepWithNext */
1079 .keepWithNext {
1080 break-after: avoid-page;
1081 break-after: avoid-page;
1082 }
1083 /* Add support for keepWithPrevious */
1084 .keepWithPrevious {
1085 break-before: avoid-page;
1086 }
1087 /* Change the approach to avoiding breaks inside artwork etc. */
1088 figure, pre, table, .artwork, .sourcecode {
1089 break-before: avoid-page;
1090 break-after: auto;
1091 }
1092 /* Avoid breaks between <dt> and <dd> */
1093 dl {
1094 break-before: auto;
1095 break-inside: auto;
1096 }
1097 dt {
1098 break-before: auto;
1099 break-after: avoid-page;
1100 }
1101 dd {
1102 break-before: avoid-page;
1103 break-after: auto;
1104 orphans: 3;
1105 widows: 3
1106 }
1107 span.break, dd.break {
1108 margin-bottom: 0;
1109 min-height: 0;
1110 break-before: auto;
1111 break-inside: auto;
1112 break-after: auto;
1113 }
1114 /* Undo break-before ToC */
1115 @media print {
1116 #toc {
1117 break-before: auto;
1118 }
1119 }
1120 /* Text in compact lists should not get extra bottim margin space,
1121 since that would makes the list not compact */
1122 ul.compact p, .ulCompact p,
1123 ol.compact p, .olCompact p {
1124 margin: 0;
1125 }
1126 /* But the list as a whole needs the extra space at the end */
1127 section ul.compact,
1128 section .ulCompact,
1129 section ol.compact,
1130 section .olCompact {
1131 margin-bottom: 1em; /* same as p not within ul.compact etc. */
1132 }
1133 /* The tt and code background above interferes with for instance table cell
1134 backgrounds. Changed to something a bit more selective. */
1135 tt, code {
1136 background-color: transparent;
1137 }
1138 p tt, p code, li tt, li code {
1139 background-color: #f8f8f8;
1140 }
1141 /* Tweak the pre margin -- 0px doesn't come out well */
1142 pre {
1143 margin-top: 0.5px;
1144 }
1145 /* Tweak the comact list text */
1146 ul.compact, .ulCompact,
1147 ol.compact, .olCompact,
1148 dl.compact, .dlCompact {
1149 line-height: normal;
1150 }
1151 /* Don't add top margin for nested lists */
1152 li > ul, li > ol, li > dl,
1153 dd > ul, dd > ol, dd > dl,
1154 dl > dd > dl {
1155 margin-top: initial;
1156 }
1157 /* Elements that should not be rendered on the same line as a <dt> */
1158 /* This should match the element list in writer.text.TextWriter.render_dl() */
1159 dd > div.artwork:first-child,
1160 dd > aside:first-child,
1161 dd > figure:first-child,
1162 dd > ol:first-child,
1163 dd > div:first-child > pre.sourcecode,
1164 dd > table:first-child,
1165 dd > ul:first-child {
1166 clear: left;
1167 }
1168 /* fix for weird browser behaviour when <dd/> is empty */
1169 dt+dd:empty::before{
1170 content: "\00a0";
1171 }
1172 </style>
1173 <link href="rfc-local.css" rel="stylesheet" type="text/css">
1174 <link href="https://dx.doi.org/10.17487/rfc8819" rel="alternate">
1175 <link href="urn:issn:2070-1721" rel="alternate">
1176 <link href="https://datatracker.ietf.org/doc/draft-ietf-netmod-module-tags-10" rel="prev">
1177 </head>
1178 <body>
1179 <script src="https://www.rfc-editor.org/js/metadata.min.js"></script>
1180 <table class="ears">
1181 <thead><tr>
1182 <td class="left">RFC 8819</td>
1183 <td class="center">YANG Module Tags</td>
1184 <td class="right">January 2021</td>
1185 </tr></thead>
1186 <tfoot><tr>
1187 <td class="left">Hopps, et al.</td>
1188 <td class="center">Standards Track</td>
1189 <td class="right">[Page]</td>
1190 </tr></tfoot>
1191 </table>
1192 <div id="external-metadata" class="document-information"></div>
1193 <div id="internal-metadata" class="document-information">
1194 <dl id="identifiers">
1195 <dt class="label-stream">Stream:</dt>
1196 <dd class="stream">Internet Engineering Task Force (IETF)</dd>
1197 <dt class="label-rfc">RFC:</dt>
1198 <dd class="rfc"><a href="https://www.rfc-editor.org/rfc/rfc8819" class="eref">8819</a></dd>
1199 <dt class="label-updates">Updates:</dt>
1200 <dd class="updates">
1201 <a href="https://www.rfc-editor.org/rfc/rfc8407" class="eref">8407</a> </dd>
1202 <dt class="label-category">Category:</dt>
1203 <dd class="category">Standards Track</dd>
1204 <dt class="label-published">Published:</dt>
1205 <dd class="published">
1206 <time datetime="2021-01" class="published">January 2021</time>
1207 </dd>
1208 <dt class="label-issn">ISSN:</dt>
1209 <dd class="issn">2070-1721</dd>
1210 <dt class="label-authors">Authors:</dt>
1211 <dd class="authors">
1212 <div class="author">
1213 <div class="author-name">C. Hopps</div>
1214 <div class="org">LabN Consulting, L.L.C.</div>
1215 </div>
1216 <div class="author">
1217 <div class="author-name">L. Berger</div>
1218 <div class="org">LabN Consulting, L.L.C.</div>
1219 </div>
1220 <div class="author">
1221 <div class="author-name">D. Bogdanovic</div>
1222 <div class="org">Volta Networks</div>
1223 </div>
1224 </dd>
1225 </dl>
1226 </div>
1227 <h1 id="rfcnum">RFC 8819</h1>
1228 <h1 id="title">YANG Module Tags</h1>
1229 <section id="section-abstract">
1230 <h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
1231 <p id="section-abstract-1">This document provides for the association of tags with YANG
1232 modules. The expectation is for such tags to be used to help classify
1233 and organize modules. A method for defining, reading, and writing
1234 modules tags is provided. Tags may be registered and assigned during
1235 module definition, assigned by implementations, or dynamically defined
1236 and set by users. This document also provides guidance to future model
1237 writers; as such, this document updates RFC 8407.<a href="#section-abstract-1" class="pilcrow">¶</a></p>
1238 </section>
1239 <div id="status-of-memo">
1240 <section id="section-boilerplate.1">
1241 <h2 id="name-status-of-this-memo">
1242 <a href="#name-status-of-this-memo" class="section-name selfRef">Status of This Memo</a>
1243 </h2>
1244 <p id="section-boilerplate.1-1">
1245 This is an Internet Standards Track document.<a href="#section-boilerplate.1-1" class="pilcrow">¶</a></p>
1246 <p id="section-boilerplate.1-2">
1247 This document is a product of the Internet Engineering Task Force
1248 (IETF). It represents the consensus of the IETF community. It has
1249 received public review and has been approved for publication by
1250 the Internet Engineering Steering Group (IESG). Further
1251 information on Internet Standards is available in Section 2 of
1252 RFC 7841.<a href="#section-boilerplate.1-2" class="pilcrow">¶</a></p>
1253 <p id="section-boilerplate.1-3">
1254 Information about the current status of this document, any
1255 errata, and how to provide feedback on it may be obtained at
1256 <span><a href="https://www.rfc-editor.org/info/rfc8819">https://www.rfc-editor.org/info/rfc8819</a></span>.<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
1257 </section>
1258 </div>
1259 <div id="copyright">
1260 <section id="section-boilerplate.2">
1261 <h2 id="name-copyright-notice">
1262 <a href="#name-copyright-notice" class="section-name selfRef">Copyright Notice</a>
1263 </h2>
1264 <p id="section-boilerplate.2-1">
1265 Copyright (c) 2021 IETF Trust and the persons identified as the
1266 document authors. All rights reserved.<a href="#section-boilerplate.2-1" class="pilcrow">¶</a></p>
1267 <p id="section-boilerplate.2-2">
1268 This document is subject to BCP 78 and the IETF Trust's Legal
1269 Provisions Relating to IETF Documents
1270 (<span><a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a></span>) in effect on the date of
1271 publication of this document. Please review these documents
1272 carefully, as they describe your rights and restrictions with
1273 respect to this document. Code Components extracted from this
1274 document must include Simplified BSD License text as described in
1275 Section 4.e of the Trust Legal Provisions and are provided without
1276 warranty as described in the Simplified BSD License.<a href="#section-boilerplate.2-2" class="pilcrow">¶</a></p>
1277 </section>
1278 </div>
1279 <div id="toc">
1280 <section id="section-toc.1">
1281 <a href="#" onclick="scroll(0,0)" class="toplink">▲</a><h2 id="name-table-of-contents">
1282 <a href="#name-table-of-contents" class="section-name selfRef">Table of Contents</a>
1283 </h2>
1284 <nav class="toc"><ul class="toc ulEmpty compact">
1285 <li class="toc ulEmpty compact" id="section-toc.1-1.1">
1286 <p id="section-toc.1-1.1.1" class="keepWithNext"><a href="#section-1" class="xref">1</a>.  <a href="#name-introduction" class="xref">Introduction</a><a href="#section-toc.1-1.1.1" class="pilcrow">¶</a></p>
1287 <ul class="toc ulEmpty compact">
1288 <li class="toc ulEmpty compact" id="section-toc.1-1.1.2.1">
1289 <p id="section-toc.1-1.1.2.1.1" class="keepWithNext"><a href="#section-1.1" class="xref">1.1</a>.  <a href="#name-some-possible-use-cases-for" class="xref">Some Possible Use Cases for YANG Module Tags</a><a href="#section-toc.1-1.1.2.1.1" class="pilcrow">¶</a></p>
1290 </li>
1291 <li class="toc ulEmpty compact" id="section-toc.1-1.1.2.2">
1292 <p id="section-toc.1-1.1.2.2.1" class="keepWithNext"><a href="#section-1.2" class="xref">1.2</a>.  <a href="#name-conventions-used-in-this-do" class="xref">Conventions Used in This Document</a><a href="#section-toc.1-1.1.2.2.1" class="pilcrow">¶</a></p>
1293 </li>
1294 </ul>
1295 </li>
1296 <li class="toc ulEmpty compact" id="section-toc.1-1.2">
1297 <p id="section-toc.1-1.2.1"><a href="#section-2" class="xref">2</a>.  <a href="#name-tag-values" class="xref">Tag Values</a><a href="#section-toc.1-1.2.1" class="pilcrow">¶</a></p>
1298 <ul class="toc ulEmpty compact">
1299 <li class="toc ulEmpty compact" id="section-toc.1-1.2.2.1">
1300 <p id="section-toc.1-1.2.2.1.1"><a href="#section-2.1" class="xref">2.1</a>.  <a href="#name-ietf-tags" class="xref">IETF Tags</a><a href="#section-toc.1-1.2.2.1.1" class="pilcrow">¶</a></p>
1301 </li>
1302 <li class="toc ulEmpty compact" id="section-toc.1-1.2.2.2">
1303 <p id="section-toc.1-1.2.2.2.1"><a href="#section-2.2" class="xref">2.2</a>.  <a href="#name-vendor-tags" class="xref">Vendor Tags</a><a href="#section-toc.1-1.2.2.2.1" class="pilcrow">¶</a></p>
1304 </li>
1305 <li class="toc ulEmpty compact" id="section-toc.1-1.2.2.3">
1306 <p id="section-toc.1-1.2.2.3.1"><a href="#section-2.3" class="xref">2.3</a>.  <a href="#name-user-tags" class="xref">User Tags</a><a href="#section-toc.1-1.2.2.3.1" class="pilcrow">¶</a></p>
1307 </li>
1308 <li class="toc ulEmpty compact" id="section-toc.1-1.2.2.4">
1309 <p id="section-toc.1-1.2.2.4.1"><a href="#section-2.4" class="xref">2.4</a>.  <a href="#name-reserved-tags" class="xref">Reserved Tags</a><a href="#section-toc.1-1.2.2.4.1" class="pilcrow">¶</a></p>
1310 </li>
1311 </ul>
1312 </li>
1313 <li class="toc ulEmpty compact" id="section-toc.1-1.3">
1314 <p id="section-toc.1-1.3.1"><a href="#section-3" class="xref">3</a>.  <a href="#name-tag-management" class="xref">Tag Management</a><a href="#section-toc.1-1.3.1" class="pilcrow">¶</a></p>
1315 <ul class="toc ulEmpty compact">
1316 <li class="toc ulEmpty compact" id="section-toc.1-1.3.2.1">
1317 <p id="section-toc.1-1.3.2.1.1"><a href="#section-3.1" class="xref">3.1</a>.  <a href="#name-module-definition-tagging" class="xref">Module Definition Tagging</a><a href="#section-toc.1-1.3.2.1.1" class="pilcrow">¶</a></p>
1318 </li>
1319 <li class="toc ulEmpty compact" id="section-toc.1-1.3.2.2">
1320 <p id="section-toc.1-1.3.2.2.1"><a href="#section-3.2" class="xref">3.2</a>.  <a href="#name-implementation-tagging" class="xref">Implementation Tagging</a><a href="#section-toc.1-1.3.2.2.1" class="pilcrow">¶</a></p>
1321 </li>
1322 <li class="toc ulEmpty compact" id="section-toc.1-1.3.2.3">
1323 <p id="section-toc.1-1.3.2.3.1"><a href="#section-3.3" class="xref">3.3</a>.  <a href="#name-user-tagging" class="xref">User Tagging</a><a href="#section-toc.1-1.3.2.3.1" class="pilcrow">¶</a></p>
1324 </li>
1325 </ul>
1326 </li>
1327 <li class="toc ulEmpty compact" id="section-toc.1-1.4">
1328 <p id="section-toc.1-1.4.1"><a href="#section-4" class="xref">4</a>.  <a href="#name-tags-module-structure" class="xref">Tags Module Structure</a><a href="#section-toc.1-1.4.1" class="pilcrow">¶</a></p>
1329 <ul class="toc ulEmpty compact">
1330 <li class="toc ulEmpty compact" id="section-toc.1-1.4.2.1">
1331 <p id="section-toc.1-1.4.2.1.1"><a href="#section-4.1" class="xref">4.1</a>.  <a href="#name-tags-module-tree" class="xref">Tags Module Tree</a><a href="#section-toc.1-1.4.2.1.1" class="pilcrow">¶</a></p>
1332 </li>
1333 <li class="toc ulEmpty compact" id="section-toc.1-1.4.2.2">
1334 <p id="section-toc.1-1.4.2.2.1"><a href="#section-4.2" class="xref">4.2</a>.  <a href="#name-yang-module" class="xref">YANG Module</a><a href="#section-toc.1-1.4.2.2.1" class="pilcrow">¶</a></p>
1335 </li>
1336 </ul>
1337 </li>
1338 <li class="toc ulEmpty compact" id="section-toc.1-1.5">
1339 <p id="section-toc.1-1.5.1"><a href="#section-5" class="xref">5</a>.  <a href="#name-other-classifications" class="xref">Other Classifications</a><a href="#section-toc.1-1.5.1" class="pilcrow">¶</a></p>
1340 </li>
1341 <li class="toc ulEmpty compact" id="section-toc.1-1.6">
1342 <p id="section-toc.1-1.6.1"><a href="#section-6" class="xref">6</a>.  <a href="#name-guidelines-to-model-writers" class="xref">Guidelines to Model Writers</a><a href="#section-toc.1-1.6.1" class="pilcrow">¶</a></p>
1343 <ul class="toc ulEmpty compact">
1344 <li class="toc ulEmpty compact" id="section-toc.1-1.6.2.1">
1345 <p id="section-toc.1-1.6.2.1.1"><a href="#section-6.1" class="xref">6.1</a>.  <a href="#name-define-standard-tags" class="xref">Define Standard Tags</a><a href="#section-toc.1-1.6.2.1.1" class="pilcrow">¶</a></p>
1346 </li>
1347 </ul>
1348 </li>
1349 <li class="toc ulEmpty compact" id="section-toc.1-1.7">
1350 <p id="section-toc.1-1.7.1"><a href="#section-7" class="xref">7</a>.  <a href="#name-iana-considerations" class="xref">IANA Considerations</a><a href="#section-toc.1-1.7.1" class="pilcrow">¶</a></p>
1351 <ul class="toc ulEmpty compact">
1352 <li class="toc ulEmpty compact" id="section-toc.1-1.7.2.1">
1353 <p id="section-toc.1-1.7.2.1.1"><a href="#section-7.1" class="xref">7.1</a>.  <a href="#name-yang-module-tag-prefixes-re" class="xref">YANG Module Tag Prefixes Registry</a><a href="#section-toc.1-1.7.2.1.1" class="pilcrow">¶</a></p>
1354 </li>
1355 <li class="toc ulEmpty compact" id="section-toc.1-1.7.2.2">
1356 <p id="section-toc.1-1.7.2.2.1"><a href="#section-7.2" class="xref">7.2</a>.  <a href="#name-ietf-yang-module-tags-regis" class="xref">IETF YANG Module Tags Registry</a><a href="#section-toc.1-1.7.2.2.1" class="pilcrow">¶</a></p>
1357 </li>
1358 <li class="toc ulEmpty compact" id="section-toc.1-1.7.2.3">
1359 <p id="section-toc.1-1.7.2.3.1"><a href="#section-7.3" class="xref">7.3</a>.  <a href="#name-updates-to-the-ietf-xml-reg" class="xref">Updates to the IETF XML Registry</a><a href="#section-toc.1-1.7.2.3.1" class="pilcrow">¶</a></p>
1360 </li>
1361 <li class="toc ulEmpty compact" id="section-toc.1-1.7.2.4">
1362 <p id="section-toc.1-1.7.2.4.1"><a href="#section-7.4" class="xref">7.4</a>.  <a href="#name-updates-to-the-yang-module-" class="xref">Updates to the YANG Module Names Registry</a><a href="#section-toc.1-1.7.2.4.1" class="pilcrow">¶</a></p>
1363 </li>
1364 </ul>
1365 </li>
1366 <li class="toc ulEmpty compact" id="section-toc.1-1.8">
1367 <p id="section-toc.1-1.8.1"><a href="#section-8" class="xref">8</a>.  <a href="#name-security-considerations" class="xref">Security Considerations</a><a href="#section-toc.1-1.8.1" class="pilcrow">¶</a></p>
1368 </li>
1369 <li class="toc ulEmpty compact" id="section-toc.1-1.9">
1370 <p id="section-toc.1-1.9.1"><a href="#section-9" class="xref">9</a>.  <a href="#name-references" class="xref">References</a><a href="#section-toc.1-1.9.1" class="pilcrow">¶</a></p>
1371 <ul class="toc ulEmpty compact">
1372 <li class="toc ulEmpty compact" id="section-toc.1-1.9.2.1">
1373 <p id="section-toc.1-1.9.2.1.1"><a href="#section-9.1" class="xref">9.1</a>.  <a href="#name-normative-references" class="xref">Normative References</a><a href="#section-toc.1-1.9.2.1.1" class="pilcrow">¶</a></p>
1374 </li>
1375 <li class="toc ulEmpty compact" id="section-toc.1-1.9.2.2">
1376 <p id="section-toc.1-1.9.2.2.1"><a href="#section-9.2" class="xref">9.2</a>.  <a href="#name-informative-references" class="xref">Informative References</a><a href="#section-toc.1-1.9.2.2.1" class="pilcrow">¶</a></p>
1377 </li>
1378 </ul>
1379 </li>
1380 <li class="toc ulEmpty compact" id="section-toc.1-1.10">
1381 <p id="section-toc.1-1.10.1"><a href="#section-appendix.a" class="xref">Appendix A</a>.  <a href="#name-examples" class="xref">Examples</a><a href="#section-toc.1-1.10.1" class="pilcrow">¶</a></p>
1382 </li>
1383 <li class="toc ulEmpty compact" id="section-toc.1-1.11">
1384 <p id="section-toc.1-1.11.1"><a href="#section-appendix.b" class="xref">Appendix B</a>.  <a href="#name-non-nmda-state-module" class="xref">Non-NMDA State Module</a><a href="#section-toc.1-1.11.1" class="pilcrow">¶</a></p>
1385 </li>
1386 <li class="toc ulEmpty compact" id="section-toc.1-1.12">
1387 <p id="section-toc.1-1.12.1"><a href="#section-appendix.c" class="xref"></a><a href="#name-acknowledgements" class="xref">Acknowledgements</a><a href="#section-toc.1-1.12.1" class="pilcrow">¶</a></p>
1388 </li>
1389 <li class="toc ulEmpty compact" id="section-toc.1-1.13">
1390 <p id="section-toc.1-1.13.1"><a href="#section-appendix.d" class="xref"></a><a href="#name-authors-addresses" class="xref">Authors' Addresses</a><a href="#section-toc.1-1.13.1" class="pilcrow">¶</a></p>
1391 </li>
1392 </ul>
1393 </nav>
1394 </section>
1395 </div>
1396 <section id="section-1">
1397 <h2 id="name-introduction">
1398 <a href="#section-1" class="section-number selfRef">1. </a><a href="#name-introduction" class="section-name selfRef">Introduction</a>
1399 </h2>
1400 <p id="section-1-1">The use of tags for classification and organization is fairly
1401 ubiquitous not only within IETF protocols but in the internet itself
1402 (e.g., <code>#hashtags</code>).
1403
1404 One benefit of using tags for organization
1405 over a rigid structure is that it is more flexible and can more easily
1406 adapt over time as technologies evolve. Tags can be usefully registered,
1407 but they can also serve as a non-registered mechanism available for
1408 users to define themselves. This document provides a mechanism to define
1409 tags and associate them with YANG modules in a flexible manner. In
1410 particular, tags may be registered as well as assigned during module
1411 definition, assigned by implementations, or dynamically defined and set
1412 by users.<a href="#section-1-1" class="pilcrow">¶</a></p>
1413 <p id="section-1-2">This document defines a YANG module <span>[<a href="#RFC7950" class="xref">RFC7950</a>]</span> that provides a list of module entries to allow for
1414 adding or removing tags as well as viewing the set of tags associated
1415 with a module.<a href="#section-1-2" class="pilcrow">¶</a></p>
1416 <p id="section-1-3">This document defines an extension statement to indicate
1417 tags that <span class="bcp14">SHOULD</span> be added by the module implementation
1418 automatically (i.e., outside of configuration).<a href="#section-1-3" class="pilcrow">¶</a></p>
1419 <p id="section-1-4">This document also defines an IANA registry for tag prefixes as well
1420 as a set of globally assigned tags.<a href="#section-1-4" class="pilcrow">¶</a></p>
1421 <p id="section-1-5"><a href="#sec-guidelines-to-model-writers" class="xref">Section 6</a>
1422 provides guidelines for authors of YANG data models.<a href="#section-1-5" class="pilcrow">¶</a></p>
1423 <p id="section-1-6">This document updates <span>[<a href="#RFC8407" class="xref">RFC8407</a>]</span>.<a href="#section-1-6" class="pilcrow">¶</a></p>
1424 <p id="section-1-7">The YANG data model in this document conforms to the Network
1425 Management Datastore Architecture (NMDA) defined in <span>[<a href="#RFC8342" class="xref">RFC8342</a>]</span>.<a href="#section-1-7" class="pilcrow">¶</a></p>
1426 <section id="section-1.1">
1427 <h3 id="name-some-possible-use-cases-for">
1428 <a href="#section-1.1" class="section-number selfRef">1.1. </a><a href="#name-some-possible-use-cases-for" class="section-name selfRef">Some Possible Use Cases for YANG Module Tags</a>
1429 </h3>
1430 <p id="section-1.1-1">During this document's development, there were requests for example
1431 uses of module tags. The following are a few example use cases for
1432 tags. This list is certainly not exhaustive.<a href="#section-1.1-1" class="pilcrow">¶</a></p>
1433 <p id="section-1.1-2">One example use of tags would be to help filter different discrete
1434 categories of YANG modules supported by a device. For example, if
1435 modules are suitably tagged, then an XPath query can be used to list
1436 all of the vendor modules supported by a device.<a href="#section-1.1-2" class="pilcrow">¶</a></p>
1437 <p id="section-1.1-3">Tags can also be used to help coordination when multiple,
1438 semi-independent clients are interacting with the same devices. For
1439 example, one management client could mark that some modules should not
1440 be used because they have not been verified to behave correctly, so
1441 that other management clients avoid querying the data associated with
1442 those modules.<a href="#section-1.1-3" class="pilcrow">¶</a></p>
1443 <p id="section-1.1-4">Tag classification is useful for users searching module
1444 repositories (e.g., YANG catalog). A query restricted to the
1445 'ietf:routing' module tag could be used to return only the IETF YANG
1446 modules associated with routing. Without tags, a user would need to
1447 know the name of all the IETF routing protocol YANG modules.<a href="#section-1.1-4" class="pilcrow">¶</a></p>
1448 <p id="section-1.1-5">Future management protocol extensions could allow for filtering
1449 queries of configuration or operational state on a server based on
1450 tags (for example, return all operational state related to
1451 system management).<a href="#section-1.1-5" class="pilcrow">¶</a></p>
1452 </section>
1453 <section id="section-1.2">
1454 <h3 id="name-conventions-used-in-this-do">
1455 <a href="#section-1.2" class="section-number selfRef">1.2. </a><a href="#name-conventions-used-in-this-do" class="section-name selfRef">Conventions Used in This Document</a>
1456 </h3>
1457 <p id="section-1.2-1">
1458 The key words "<span class="bcp14">MUST</span>", "<span class="bcp14">MUST NOT</span>",
1459 "<span class="bcp14">REQUIRED</span>", "<span class="bcp14">SHALL</span>", "<span class="bcp14">SHALL NOT</span>", "<span class="bcp14">SHOULD</span>", "<span class="bcp14">SHOULD NOT</span>",
1460 "<span class="bcp14">RECOMMENDED</span>", "<span class="bcp14">NOT RECOMMENDED</span>",
1461 "<span class="bcp14">MAY</span>", and "<span class="bcp14">OPTIONAL</span>" in this document are
1462 to be interpreted as
1463 described in BCP 14 <span>[<a href="#RFC2119" class="xref">RFC2119</a>]</span> <span>[<a href="#RFC8174" class="xref">RFC8174</a>]</span>
1464 when, and only when, they appear in all capitals, as shown here.<a href="#section-1.2-1" class="pilcrow">¶</a></p>
1465 </section>
1466 </section>
1467 <section id="section-2">
1468 <h2 id="name-tag-values">
1469 <a href="#section-2" class="section-number selfRef">2. </a><a href="#name-tag-values" class="section-name selfRef">Tag Values</a>
1470 </h2>
1471 <p id="section-2-1">All tags <span class="bcp14">SHOULD</span> begin with a prefix indicating who
1472 owns their definition. An IANA registry (<a href="#sec-yang-module-tag-prefixes-registry" class="xref">Section 7.1</a>) is
1473 used to support registering tag prefixes. Currently, three prefixes are
1474 defined. No further structure is imposed by this document on the value
1475 following the registered prefix, and the value can contain any YANG type
1476 'string' characters except carriage returns, newlines, and tabs.<a href="#section-2-1" class="pilcrow">¶</a></p>
1477 <p id="section-2-2">Again, except for the conflict-avoiding prefix, this document is
1478 purposefully not specifying any structure on (i.e., restricting) the tag values.
1479 The intent is to avoid arbitrarily restricting the values that
1480 designers, implementers, and users can use. As a result of this choice,
1481 designers, implementers, and users are free to add or not add any
1482 structure they may require to their own tag values.<a href="#section-2-2" class="pilcrow">¶</a></p>
1483 <div id="sec-ietf-tags">
1484 <section id="section-2.1">
1485 <h3 id="name-ietf-tags">
1486 <a href="#section-2.1" class="section-number selfRef">2.1. </a><a href="#name-ietf-tags" class="section-name selfRef">IETF Tags</a>
1487 </h3>
1488 <p id="section-2.1-1">An IETF tag is a tag that has the prefix "ietf:". All IETF tags are
1489 registered with IANA in a registry defined later in this document
1490 (<a href="#sec-ietf-yang-module-tags-registry" class="xref">Section 7.2</a>).<a href="#section-2.1-1" class="pilcrow">¶</a></p>
1491 </section>
1492 </div>
1493 <section id="section-2.2">
1494 <h3 id="name-vendor-tags">
1495 <a href="#section-2.2" class="section-number selfRef">2.2. </a><a href="#name-vendor-tags" class="section-name selfRef">Vendor Tags</a>
1496 </h3>
1497 <p id="section-2.2-1">A vendor tag is a tag that has the prefix "vendor:". These tags are
1498 defined by the vendor that implements the module and are not
1499 registered; however, it is <span class="bcp14">RECOMMENDED</span> that the vendor
1500 include extra identification in the tag to avoid collisions, such as
1501 using the enterprise or organization name following the "vendor:"
1502 prefix (e.g., vendor:example.com:vendor-defined-classifier).<a href="#section-2.2-1" class="pilcrow">¶</a></p>
1503 </section>
1504 <section id="section-2.3">
1505 <h3 id="name-user-tags">
1506 <a href="#section-2.3" class="section-number selfRef">2.3. </a><a href="#name-user-tags" class="section-name selfRef">User Tags</a>
1507 </h3>
1508 <p id="section-2.3-1">A user tag is any tag that has the prefix "user:". These tags are
1509 defined by the user/administrator and are not meant to be
1510 registered. Users are not required to use the "user:" prefix; however,
1511 doing so is <span class="bcp14">RECOMMENDED</span> as it helps avoid
1512 collisions.<a href="#section-2.3-1" class="pilcrow">¶</a></p>
1513 </section>
1514 <section id="section-2.4">
1515 <h3 id="name-reserved-tags">
1516 <a href="#section-2.4" class="section-number selfRef">2.4. </a><a href="#name-reserved-tags" class="section-name selfRef">Reserved Tags</a>
1517 </h3>
1518 <p id="section-2.4-1">Any tag not starting with the prefix "ietf:", "vendor:", or "user:"
1519 is reserved for future use. These tag values are not invalid but
1520 simply reserved in the context of specifications (e.g., RFCs).<a href="#section-2.4-1" class="pilcrow">¶</a></p>
1521 </section>
1522 </section>
1523 <section id="section-3">
1524 <h2 id="name-tag-management">
1525 <a href="#section-3" class="section-number selfRef">3. </a><a href="#name-tag-management" class="section-name selfRef">Tag Management</a>
1526 </h2>
1527 <p id="section-3-1">Tags can become associated with a module in a number of ways. Tags
1528 may be defined and associated at module design time, at implementation
1529 time, or via user administrative control. As the main consumer of tags
1530 are users, users may also remove any tag, no matter how the tag became
1531 associated with a module.<a href="#section-3-1" class="pilcrow">¶</a></p>
1532 <section id="section-3.1">
1533 <h3 id="name-module-definition-tagging">
1534 <a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-module-definition-tagging" class="section-name selfRef">Module Definition Tagging</a>
1535 </h3>
1536 <p id="section-3.1-1">A module definition <span class="bcp14">MAY</span> indicate a set of tags to be
1537 added by the module implementer. These design-time tags are indicated
1538 using the module-tag extension statement.<a href="#section-3.1-1" class="pilcrow">¶</a></p>
1539 <p id="section-3.1-2">If the module is defined in an IETF Standards Track document, the
1540 tags <span class="bcp14">MUST</span> be IETF tags (<a href="#sec-ietf-tags" class="xref">Section 2.1</a>). Thus, new modules can drive
1541 the addition of new IETF tags to the IANA registry defined in <a href="#sec-ietf-yang-module-tags-registry" class="xref">Section 7.2</a>, and
1542 the IANA registry can serve as a check against duplication.<a href="#section-3.1-2" class="pilcrow">¶</a></p>
1543 </section>
1544 <section id="section-3.2">
1545 <h3 id="name-implementation-tagging">
1546 <a href="#section-3.2" class="section-number selfRef">3.2. </a><a href="#name-implementation-tagging" class="section-name selfRef">Implementation Tagging</a>
1547 </h3>
1548 <p id="section-3.2-1">An implementation <span class="bcp14">MAY</span> include additional tags
1549 associated with a module. These tags <span class="bcp14">SHOULD</span> be IETF
1550 tags (i.e., registered) or vendor-specific tags.<a href="#section-3.2-1" class="pilcrow">¶</a></p>
1551 </section>
1552 <section id="section-3.3">
1553 <h3 id="name-user-tagging">
1554 <a href="#section-3.3" class="section-number selfRef">3.3. </a><a href="#name-user-tagging" class="section-name selfRef">User Tagging</a>
1555 </h3>
1556 <p id="section-3.3-1">Tags of any kind, with or without a prefix, can be assigned and
1557 removed by the user using normal configuration mechanisms. In order to
1558 remove a tag from the operational datastore, the user adds a matching
1559 <code>masked-tag</code> entry for a given module.<a href="#section-3.3-1" class="pilcrow">¶</a></p>
1560 </section>
1561 </section>
1562 <section id="section-4">
1563 <h2 id="name-tags-module-structure">
1564 <a href="#section-4" class="section-number selfRef">4. </a><a href="#name-tags-module-structure" class="section-name selfRef">Tags Module Structure</a>
1565 </h2>
1566 <section id="section-4.1">
1567 <h3 id="name-tags-module-tree">
1568 <a href="#section-4.1" class="section-number selfRef">4.1. </a><a href="#name-tags-module-tree" class="section-name selfRef">Tags Module Tree</a>
1569 </h3>
1570 <p id="section-4.1-1">The tree associated with the "ietf-module-tags" module follows. The
1571 meaning of the symbols can be found in <span>[<a href="#RFC8340" class="xref">RFC8340</a>]</span>.<a href="#section-4.1-1" class="pilcrow">¶</a></p>
1572 <span id="name-yang-module-tags-tree-diagr"></span><div id="sec-yang-module-tags-tree-diagram">
1573 <figure id="figure-1">
1574 <div id="section-4.1-2.1">
1575 <pre class="sourcecode lang-yangtree">
1576 module: ietf-module-tags
1577 +--rw module-tags
1578 +--rw module* [name]
1579 +--rw name yang:yang-identifier
1580 +--rw tag* tag
1581 +--rw masked-tag* tag
1582 </pre>
1583 </div>
1584 <figcaption><a href="#figure-1" class="selfRef">Figure 1</a>:
1585 <a href="#name-yang-module-tags-tree-diagr" class="selfRef">YANG Module Tags Tree Diagram</a>
1586 </figcaption></figure>
1587 </div>
1588 </section>
1589 <section id="section-4.2">
1590 <h3 id="name-yang-module">
1591 <a href="#section-4.2" class="section-number selfRef">4.2. </a><a href="#name-yang-module" class="section-name selfRef">YANG Module</a>
1592 </h3>
1593 <span id="name-module-tags-module"></span><div id="sec-module-tags-module">
1594 <figure id="figure-2">
1595 <div id="section-4.2-1.1">
1596 <pre class="sourcecode lang-yang">&lt;CODE BEGINS&gt; file "[email protected]"
1597
1598 module ietf-module-tags {
1599 yang-version 1.1;
1600 namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags";
1601 prefix tags;
1602
1603 import ietf-yang-types {
1604 prefix yang;
1605 }
1606
1607 organization
1608 "IETF NetMod Working Group (NetMod)";
1609 contact
1610 "WG Web: &lt;https://datatracker.ietf.org/wg/netmod/&gt;
1611 WG List: &lt;mailto:[email protected]&gt;
1612
1613 Author: Christian Hopps
1614 &lt;mailto:[email protected]&gt;
1615
1616 Author: Lou Berger
1617 &lt;mailto:[email protected]&gt;
1618
1619 Author: Dean Bogdanovic
1620 &lt;mailto:[email protected]&gt;";
1621
1622 description
1623 "This module describes a mechanism associating tags with YANG
1624 modules. Tags may be IANA assigned or privately defined.
1625
1626 Copyright (c) 2021 IETF Trust and the persons identified as
1627 authors of the code. All rights reserved.
1628
1629 Redistribution and use in source and binary forms, with or
1630 without modification, is permitted pursuant to, and subject to
1631 the license terms contained in, the Simplified BSD License set
1632 forth in Section 4.c of the IETF Trust's Legal Provisions
1633 Relating to IETF Documents
1634 (https://trustee.ietf.org/license-info).
1635
1636 This version of this YANG module is part of RFC 8819
1637 (https://www.rfc-editor.org/info/rfc8819); see the RFC itself
1638 for full legal notices.
1639
1640 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
1641 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
1642 'MAY', and 'OPTIONAL' in this document are to be interpreted as
1643 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
1644 they appear in all capitals, as shown here.";
1645
1646 revision 2021-01-04 {
1647 description
1648 "Initial revision.";
1649 reference
1650 "RFC 8819: YANG Module Tags";
1651 }
1652
1653 typedef tag {
1654 type string {
1655 length "1..max";
1656 pattern '[\S ]+';
1657 }
1658 description
1659 "A tag is a type of 'string' value that does not include
1660 carriage return, newline, or tab characters. It SHOULD begin
1661 with a registered prefix; however, tags without a registered
1662 prefix SHOULD NOT be treated as invalid.";
1663 }
1664
1665 extension module-tag {
1666 argument tag;
1667 description
1668 "The argument 'tag' is of type 'tag'. This extension statement
1669 is used by module authors to indicate the tags that SHOULD be
1670 added automatically by the system. As such, the origin of the
1671 value for the predefined tags should be set to 'system'
1672 [RFC8342].";
1673 }
1674
1675 container module-tags {
1676 description
1677 "Contains the list of modules and their associated tags.";
1678 list module {
1679 key "name";
1680 description
1681 "A list of modules and their associated tags.";
1682 leaf name {
1683 type yang:yang-identifier;
1684 mandatory true;
1685 description
1686 "The YANG module name.";
1687 }
1688 leaf-list tag {
1689 type tag;
1690 description
1691 "Tags associated with the module. See the IANA 'YANG
1692 Module Tag Prefixes' registry for reserved prefixes and
1693 the IANA 'IETF YANG Module Tags' registry for IETF tags.
1694
1695 The 'operational' state [RFC8342] view of this list is
1696 constructed using the following steps:
1697
1698 1) System tags (i.e., tags of 'system' origin) are added.
1699 2) User-configured tags (i.e., tags of 'intended' origin)
1700 are added.
1701 3) Any tag that is equal to a masked-tag is removed.";
1702 }
1703 leaf-list masked-tag {
1704 type tag;
1705 description
1706 "The list of tags that should not be associated with this
1707 module. The user can remove (mask) tags from the
1708 operational state datastore [RFC8342] by adding them to
1709 this list. It is not an error to add tags to this list
1710 that are not associated with the module, but they have no
1711 operational effect.";
1712 }
1713 }
1714 }
1715 }
1716
1717
1718 &lt;CODE ENDS&gt;</pre>
1719 </div>
1720 <figcaption><a href="#figure-2" class="selfRef">Figure 2</a>:
1721 <a href="#name-module-tags-module" class="selfRef">Module Tags Module</a>
1722 </figcaption></figure>
1723 </div>
1724 </section>
1725 </section>
1726 <section id="section-5">
1727 <h2 id="name-other-classifications">
1728 <a href="#section-5" class="section-number selfRef">5. </a><a href="#name-other-classifications" class="section-name selfRef">Other Classifications</a>
1729 </h2>
1730 <p id="section-5-1">It is worth noting that a different YANG module classification
1731 document exists <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>. That document
1732 only classifies modules in a logical manner and does not define tagging
1733 or any other mechanisms. It divides YANG modules into two categories
1734 (service or element) and then into one of three origins: standard,
1735 vendor, or user. It does provide a good way to discuss and identify
1736 modules in general. This document defines IETF tags to support the
1737 classification style described in <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>.<a href="#section-5-1" class="pilcrow">¶</a></p>
1738 </section>
1739 <div id="sec-guidelines-to-model-writers">
1740 <section id="section-6">
1741 <h2 id="name-guidelines-to-model-writers">
1742 <a href="#section-6" class="section-number selfRef">6. </a><a href="#name-guidelines-to-model-writers" class="section-name selfRef">Guidelines to Model Writers</a>
1743 </h2>
1744 <p id="section-6-1">This section updates <span>[<a href="#RFC8407" class="xref">RFC8407</a>]</span>.<a href="#section-6-1" class="pilcrow">¶</a></p>
1745 <section id="section-6.1">
1746 <h3 id="name-define-standard-tags">
1747 <a href="#section-6.1" class="section-number selfRef">6.1. </a><a href="#name-define-standard-tags" class="section-name selfRef">Define Standard Tags</a>
1748 </h3>
1749 <p id="section-6.1-1">A module <span class="bcp14">MAY</span> indicate, using module-tag extension
1750 statements, a set of tags that are to be automatically associated with
1751 it (i.e., not added through configuration).<a href="#section-6.1-1" class="pilcrow">¶</a></p>
1752 <div id="section-6.1-2">
1753 <pre class="sourcecode lang-yang">
1754 module example-module {
1755 namespace "https://example.com/yang/example";
1756 prefix "ex";
1757 //...
1758 import module-tags { prefix tags; }
1759
1760 tags:module-tag "ietf:some-new-tag";
1761 tags:module-tag "ietf:some-other-tag";
1762 // ...
1763 }
1764 </pre><a href="#section-6.1-2" class="pilcrow">¶</a>
1765 </div>
1766 <p id="section-6.1-3">The module writer can use existing standard tags or use new tags
1767 defined in the model definition, as appropriate. For IETF standardized
1768 modules, new tags <span class="bcp14">MUST</span> be assigned in the IANA registry
1769 defined below, see <a href="#sec-ietf-yang-module-tags-registry" class="xref">Section 7.2</a>.<a href="#section-6.1-3" class="pilcrow">¶</a></p>
1770 </section>
1771 </section>
1772 </div>
1773 <section id="section-7">
1774 <h2 id="name-iana-considerations">
1775 <a href="#section-7" class="section-number selfRef">7. </a><a href="#name-iana-considerations" class="section-name selfRef">IANA Considerations</a>
1776 </h2>
1777 <div id="sec-yang-module-tag-prefixes-registry">
1778 <section id="section-7.1">
1779 <h3 id="name-yang-module-tag-prefixes-re">
1780 <a href="#section-7.1" class="section-number selfRef">7.1. </a><a href="#name-yang-module-tag-prefixes-re" class="section-name selfRef">YANG Module Tag Prefixes Registry</a>
1781 </h3>
1782 <p id="section-7.1-1">IANA has created the "YANG Module Tag Prefixes" subregistry
1783 in the "YANG Module Tags" registry.<a href="#section-7.1-1" class="pilcrow">¶</a></p>
1784 <p id="section-7.1-2">This registry allocates tag prefixes. All YANG module tags
1785 <span class="bcp14">SHOULD</span> begin with one of the prefixes in this registry.<a href="#section-7.1-2" class="pilcrow">¶</a></p>
1786 <p id="section-7.1-3">Prefix entries in this registry should be short strings consisting
1787 of lowercase ASCII alpha-numeric characters and a final ":" character.<a href="#section-7.1-3" class="pilcrow">¶</a></p>
1788 <p id="section-7.1-4">The allocation policy for this registry is Specification Required
1789 <span>[<a href="#RFC8126" class="xref">RFC8126</a>]</span>. The Reference and Assignee
1790 values should be sufficient to identify and contact the organization
1791 that has been allocated the prefix.<a href="#section-7.1-4" class="pilcrow">¶</a></p>
1792 <p id="section-7.1-5">The initial values for this registry are as follows.<a href="#section-7.1-5" class="pilcrow">¶</a></p>
1793 <table class="center" id="table-1">
1794 <caption><a href="#table-1" class="selfRef">Table 1</a></caption>
1795 <thead>
1796 <tr>
1797 <th class="text-left" rowspan="1" colspan="1">Prefix</th>
1798 <th class="text-left" rowspan="1" colspan="1">Description</th>
1799 <th class="text-left" rowspan="1" colspan="1">Reference</th>
1800 <th class="text-left" rowspan="1" colspan="1">Assignee</th>
1801 </tr>
1802 </thead>
1803 <tbody>
1804 <tr>
1805 <td class="text-left" rowspan="1" colspan="1">ietf:</td>
1806 <td class="text-left" rowspan="1" colspan="1">IETF tags allocated in the IANA "IETF YANG
1807 Module Tags" registry.</td>
1808 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1809 <td class="text-left" rowspan="1" colspan="1">IETF</td>
1810 </tr>
1811 <tr>
1812 <td class="text-left" rowspan="1" colspan="1">vendor:</td>
1813 <td class="text-left" rowspan="1" colspan="1">Non-registered tags allocated by the module
1814 implementer.</td>
1815 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1816 <td class="text-left" rowspan="1" colspan="1">IETF</td>
1817 </tr>
1818 <tr>
1819 <td class="text-left" rowspan="1" colspan="1">user:</td>
1820 <td class="text-left" rowspan="1" colspan="1">Non-registered tags allocated by and for the
1821 user.</td>
1822 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1823 <td class="text-left" rowspan="1" colspan="1">IETF</td>
1824 </tr>
1825 </tbody>
1826 </table>
1827 <p id="section-7.1-7">Other standards development organizations (SDOs) wishing to
1828 allocate their own set of tags should allocate a prefix from this
1829 registry.<a href="#section-7.1-7" class="pilcrow">¶</a></p>
1830 </section>
1831 </div>
1832 <div id="sec-ietf-yang-module-tags-registry">
1833 <section id="section-7.2">
1834 <h3 id="name-ietf-yang-module-tags-regis">
1835 <a href="#section-7.2" class="section-number selfRef">7.2. </a><a href="#name-ietf-yang-module-tags-regis" class="section-name selfRef">IETF YANG Module Tags Registry</a>
1836 </h3>
1837 <p id="section-7.2-1">IANA has created the "IETF YANG Module Tags" subregistry
1838 within the "YANG Module Tags" registry . This
1839 registry appears below the "YANG Module Tag Prefixes" registry.<a href="#section-7.2-1" class="pilcrow">¶</a></p>
1840 <p id="section-7.2-2">This registry allocates tags that have the registered prefix
1841 "ietf:". New values should be well considered and not achievable
1842 through a combination of already existing IETF tags. IANA assigned
1843 tags must conform to Net-Unicode as defined in <span>[<a href="#RFC5198" class="xref">RFC5198</a>]</span>, and they shall not need normalization.<a href="#section-7.2-2" class="pilcrow">¶</a></p>
1844 <p id="section-7.2-3">The allocation policy for this registry is IETF Review <span>[<a href="#RFC8126" class="xref">RFC8126</a>]</span>.<a href="#section-7.2-3" class="pilcrow">¶</a></p>
1845 <p id="section-7.2-4">The initial values for this registry are as follows.<a href="#section-7.2-4" class="pilcrow">¶</a></p>
1846 <table class="center" id="table-2">
1847 <caption><a href="#table-2" class="selfRef">Table 2</a></caption>
1848 <thead>
1849 <tr>
1850 <th class="text-left" rowspan="1" colspan="1">Tag</th>
1851 <th class="text-left" rowspan="1" colspan="1">Description</th>
1852 <th class="text-left" rowspan="1" colspan="1">Reference</th>
1853 </tr>
1854 </thead>
1855 <tbody>
1856 <tr>
1857 <td class="text-left" rowspan="1" colspan="1">ietf:network-element-class</td>
1858 <td class="text-left" rowspan="1" colspan="1">Network element as defined in
1859 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>.</td>
1860 <td class="text-left" rowspan="1" colspan="1">
1861 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>
1862 </td>
1863 </tr>
1864 <tr>
1865 <td class="text-left" rowspan="1" colspan="1">ietf:network-service-class</td>
1866 <td class="text-left" rowspan="1" colspan="1">Network service as defined in
1867 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>.</td>
1868 <td class="text-left" rowspan="1" colspan="1">
1869 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>
1870 </td>
1871 </tr>
1872 <tr>
1873 <td class="text-left" rowspan="1" colspan="1">ietf:sdo-defined-class</td>
1874 <td class="text-left" rowspan="1" colspan="1">Module is defined by a standards organization.</td>
1875 <td class="text-left" rowspan="1" colspan="1">
1876 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>
1877 </td>
1878 </tr>
1879 <tr>
1880 <td class="text-left" rowspan="1" colspan="1">ietf:vendor-defined-class</td>
1881 <td class="text-left" rowspan="1" colspan="1">Module is defined by a vendor.</td>
1882 <td class="text-left" rowspan="1" colspan="1">
1883 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>
1884 </td>
1885 </tr>
1886 <tr>
1887 <td class="text-left" rowspan="1" colspan="1">ietf:user-defined-class</td>
1888 <td class="text-left" rowspan="1" colspan="1">Module is defined by the user.</td>
1889 <td class="text-left" rowspan="1" colspan="1">
1890 <span>[<a href="#RFC8199" class="xref">RFC8199</a>]</span>
1891 </td>
1892 </tr>
1893 <tr>
1894 <td class="text-left" rowspan="1" colspan="1">ietf:hardware</td>
1895 <td class="text-left" rowspan="1" colspan="1">Relates to hardware (e.g., inventory).</td>
1896 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1897 </tr>
1898 <tr>
1899 <td class="text-left" rowspan="1" colspan="1">ietf:software</td>
1900 <td class="text-left" rowspan="1" colspan="1">Relates to software (e.g., installed OS).</td>
1901 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1902 </tr>
1903 <tr>
1904 <td class="text-left" rowspan="1" colspan="1">ietf:protocol</td>
1905 <td class="text-left" rowspan="1" colspan="1">Represents a protocol (often combined with
1906 another tag to refine).</td>
1907 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1908 </tr>
1909 <tr>
1910 <td class="text-left" rowspan="1" colspan="1">ietf:qos</td>
1911 <td class="text-left" rowspan="1" colspan="1">Relates to quality of service.</td>
1912 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1913 </tr>
1914 <tr>
1915 <td class="text-left" rowspan="1" colspan="1">ietf:network-service-app</td>
1916 <td class="text-left" rowspan="1" colspan="1">Relates to a network service application (e.g.,
1917 an NTP server, DNS server, DHCP server, etc.).</td>
1918 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1919 </tr>
1920 <tr>
1921 <td class="text-left" rowspan="1" colspan="1">ietf:system-management</td>
1922 <td class="text-left" rowspan="1" colspan="1">Relates to system management (e.g., a system
1923 management protocol such as syslog, TACAC+, SNMP, NETCONF, etc.).</td>
1924 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1925 </tr>
1926 <tr>
1927 <td class="text-left" rowspan="1" colspan="1">ietf:oam</td>
1928 <td class="text-left" rowspan="1" colspan="1">Relates to Operations, Administration, and
1929 Maintenance (e.g., BFD).</td>
1930 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1931 </tr>
1932 <tr>
1933 <td class="text-left" rowspan="1" colspan="1">ietf:routing</td>
1934 <td class="text-left" rowspan="1" colspan="1">Relates to routing.</td>
1935 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1936 </tr>
1937 <tr>
1938 <td class="text-left" rowspan="1" colspan="1">ietf:security</td>
1939 <td class="text-left" rowspan="1" colspan="1">Related to security.</td>
1940 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1941 </tr>
1942 <tr>
1943 <td class="text-left" rowspan="1" colspan="1">ietf:signaling</td>
1944 <td class="text-left" rowspan="1" colspan="1">Relates to control-plane signaling.</td>
1945 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1946 </tr>
1947 <tr>
1948 <td class="text-left" rowspan="1" colspan="1">ietf:link-management</td>
1949 <td class="text-left" rowspan="1" colspan="1">Relates to link management.</td>
1950 <td class="text-left" rowspan="1" colspan="1">RFC 8819</td>
1951 </tr>
1952 </tbody>
1953 </table>
1954 </section>
1955 </div>
1956 <section id="section-7.3">
1957 <h3 id="name-updates-to-the-ietf-xml-reg">
1958 <a href="#section-7.3" class="section-number selfRef">7.3. </a><a href="#name-updates-to-the-ietf-xml-reg" class="section-name selfRef">Updates to the IETF XML Registry</a>
1959 </h3>
1960 <p id="section-7.3-1">This document registers a URI in the "IETF XML Registry" <span>[<a href="#RFC3688" class="xref">RFC3688</a>]</span>. Following the format in <span>[<a href="#RFC3688" class="xref">RFC3688</a>]</span>, the following registrations have
1961 been made:<a href="#section-7.3-1" class="pilcrow">¶</a></p>
1962 <span class="break"></span><dl class="dlParallel dlCompact" id="section-7.3-2">
1963 <dt id="section-7.3-2.1">URI:</dt>
1964 <dd style="margin-left: 1.5em" id="section-7.3-2.2">urn:ietf:params:xml:ns:yang:ietf-module-tags<a href="#section-7.3-2.2" class="pilcrow">¶</a>
1965 </dd>
1966 <dd class="break"></dd>
1967 <dt id="section-7.3-2.3">Registrant Contact:</dt>
1968 <dd style="margin-left: 1.5em" id="section-7.3-2.4">The IESG.<a href="#section-7.3-2.4" class="pilcrow">¶</a>
1969 </dd>
1970 <dd class="break"></dd>
1971 <dt id="section-7.3-2.5">XML:</dt>
1972 <dd style="margin-left: 1.5em" id="section-7.3-2.6">N/A; the requested URI is an XML namespace.<a href="#section-7.3-2.6" class="pilcrow">¶</a>
1973 </dd>
1974 <dd class="break"></dd>
1975 </dl>
1976 <span class="break"></span><dl class="dlParallel dlCompact" id="section-7.3-3">
1977 <dt id="section-7.3-3.1">URI:</dt>
1978 <dd style="margin-left: 1.5em" id="section-7.3-3.2">urn:ietf:params:xml:ns:yang:ietf-module-tags-state<a href="#section-7.3-3.2" class="pilcrow">¶</a>
1979 </dd>
1980 <dd class="break"></dd>
1981 <dt id="section-7.3-3.3">Registrant Contact:</dt>
1982 <dd style="margin-left: 1.5em" id="section-7.3-3.4">The IESG.<a href="#section-7.3-3.4" class="pilcrow">¶</a>
1983 </dd>
1984 <dd class="break"></dd>
1985 <dt id="section-7.3-3.5">XML:</dt>
1986 <dd style="margin-left: 1.5em" id="section-7.3-3.6">N/A; the requested URI is an XML namespace.<a href="#section-7.3-3.6" class="pilcrow">¶</a>
1987 </dd>
1988 <dd class="break"></dd>
1989 </dl>
1990 </section>
1991 <section id="section-7.4">
1992 <h3 id="name-updates-to-the-yang-module-">
1993 <a href="#section-7.4" class="section-number selfRef">7.4. </a><a href="#name-updates-to-the-yang-module-" class="section-name selfRef">Updates to the YANG Module Names Registry</a>
1994 </h3>
1995 <p id="section-7.4-1">This document registers two YANG modules in the "YANG Module Names"
1996 registry <span>[<a href="#RFC6020" class="xref">RFC6020</a>]</span>. Following the
1997 format in <span>[<a href="#RFC6020" class="xref">RFC6020</a>]</span>, the following
1998 registrations have been made:<a href="#section-7.4-1" class="pilcrow">¶</a></p>
1999 <span class="break"></span><dl class="dlParallel dlCompact" id="section-7.4-2">
2000 <dt id="section-7.4-2.1">name:</dt>
2001 <dd style="margin-left: 1.5em" id="section-7.4-2.2">ietf-module-tags<a href="#section-7.4-2.2" class="pilcrow">¶</a>
2002 </dd>
2003 <dd class="break"></dd>
2004 <dt id="section-7.4-2.3">namespace:</dt>
2005 <dd style="margin-left: 1.5em" id="section-7.4-2.4">urn:ietf:params:xml:ns:yang:ietf-module-tags<a href="#section-7.4-2.4" class="pilcrow">¶</a>
2006 </dd>
2007 <dd class="break"></dd>
2008 <dt id="section-7.4-2.5">prefix:</dt>
2009 <dd style="margin-left: 1.5em" id="section-7.4-2.6">tags<a href="#section-7.4-2.6" class="pilcrow">¶</a>
2010 </dd>
2011 <dd class="break"></dd>
2012 <dt id="section-7.4-2.7">reference:</dt>
2013 <dd style="margin-left: 1.5em" id="section-7.4-2.8">RFC 8819<a href="#section-7.4-2.8" class="pilcrow">¶</a>
2014 </dd>
2015 <dd class="break"></dd>
2016 </dl>
2017 <span class="break"></span><dl class="dlParallel dlCompact" id="section-7.4-3">
2018 <dt id="section-7.4-3.1">name:</dt>
2019 <dd style="margin-left: 1.5em" id="section-7.4-3.2">ietf-module-tags-state<a href="#section-7.4-3.2" class="pilcrow">¶</a>
2020 </dd>
2021 <dd class="break"></dd>
2022 <dt id="section-7.4-3.3">namespace:</dt>
2023 <dd style="margin-left: 1.5em" id="section-7.4-3.4">urn:ietf:params:xml:ns:yang:ietf-module-tags-state<a href="#section-7.4-3.4" class="pilcrow">¶</a>
2024 </dd>
2025 <dd class="break"></dd>
2026 <dt id="section-7.4-3.5">prefix:</dt>
2027 <dd style="margin-left: 1.5em" id="section-7.4-3.6">tags-s<a href="#section-7.4-3.6" class="pilcrow">¶</a>
2028 </dd>
2029 <dd class="break"></dd>
2030 <dt id="section-7.4-3.7">reference:</dt>
2031 <dd style="margin-left: 1.5em" id="section-7.4-3.8">RFC 8819<a href="#section-7.4-3.8" class="pilcrow">¶</a>
2032 </dd>
2033 <dd class="break"></dd>
2034 </dl>
2035 </section>
2036 </section>
2037 <section id="section-8">
2038 <h2 id="name-security-considerations">
2039 <a href="#section-8" class="section-number selfRef">8. </a><a href="#name-security-considerations" class="section-name selfRef">Security Considerations</a>
2040 </h2>
2041 <p id="section-8-1">The YANG module defined in this memo is designed to be accessed via
2042 the NETCONF protocol <span>[<a href="#RFC6241" class="xref">RFC6241</a>]</span>. The
2043 lowest NETCONF layer is the secure transport layer and the
2044 mandatory-to-implement secure transport is Secure Shell (SSH) <span>[<a href="#RFC6242" class="xref">RFC6242</a>]</span>.<a href="#section-8-1" class="pilcrow">¶</a></p>
2045 <p id="section-8-2">This document adds the ability to associate tag metadata with YANG
2046 modules. This document does not define any actions based on these
2047 associations, and none are yet defined; therefore, it does not by
2048 itself introduce any new security considerations directly.<a href="#section-8-2" class="pilcrow">¶</a></p>
2049 <p id="section-8-3">Users of the tag metadata may define various actions to be taken
2050 based on the tag metadata. These actions and their definitions are
2051 outside the scope of this document. Users will need to consider the
2052 security implications of any actions they choose to define, including
2053 the potential for a tag to get 'masked' by another user.<a href="#section-8-3" class="pilcrow">¶</a></p>
2054 </section>
2055 <section id="section-9">
2056 <h2 id="name-references">
2057 <a href="#section-9" class="section-number selfRef">9. </a><a href="#name-references" class="section-name selfRef">References</a>
2058 </h2>
2059 <section id="section-9.1">
2060 <h3 id="name-normative-references">
2061 <a href="#section-9.1" class="section-number selfRef">9.1. </a><a href="#name-normative-references" class="section-name selfRef">Normative References</a>
2062 </h3>
2063 <dl class="references">
2064 <dt id="RFC2119">[RFC2119]</dt>
2065 <dd>
2066 <span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;</span>. </dd>
2067 <dd class="break"></dd>
2068 <dt id="RFC7950">[RFC7950]</dt>
2069 <dd>
2070 <span class="refAuthor">Bjorklund, M., Ed.</span>, <span class="refTitle">"The YANG 1.1 Data Modeling Language"</span>, <span class="seriesInfo">RFC 7950</span>, <span class="seriesInfo">DOI 10.17487/RFC7950</span>, <time datetime="2016-08" class="refDate">August 2016</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc7950">https://www.rfc-editor.org/info/rfc7950</a>&gt;</span>. </dd>
2071 <dd class="break"></dd>
2072 <dt id="RFC8126">[RFC8126]</dt>
2073 <dd>
2074 <span class="refAuthor">Cotton, M.</span><span class="refAuthor">, Leiba, B.</span><span class="refAuthor">, and T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="seriesInfo">BCP 26</span>, <span class="seriesInfo">RFC 8126</span>, <span class="seriesInfo">DOI 10.17487/RFC8126</span>, <time datetime="2017-06" class="refDate">June 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8126">https://www.rfc-editor.org/info/rfc8126</a>&gt;</span>. </dd>
2075 <dd class="break"></dd>
2076 <dt id="RFC8174">[RFC8174]</dt>
2077 <dd>
2078 <span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>&gt;</span>. </dd>
2079 <dd class="break"></dd>
2080 <dt id="RFC8199">[RFC8199]</dt>
2081 <dd>
2082 <span class="refAuthor">Bogdanovic, D.</span><span class="refAuthor">, Claise, B.</span><span class="refAuthor">, and C. Moberg</span>, <span class="refTitle">"YANG Module Classification"</span>, <span class="seriesInfo">RFC 8199</span>, <span class="seriesInfo">DOI 10.17487/RFC8199</span>, <time datetime="2017-07" class="refDate">July 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8199">https://www.rfc-editor.org/info/rfc8199</a>&gt;</span>. </dd>
2083 <dd class="break"></dd>
2084 <dt id="RFC8342">[RFC8342]</dt>
2085 <dd>
2086 <span class="refAuthor">Bjorklund, M.</span><span class="refAuthor">, Schoenwaelder, J.</span><span class="refAuthor">, Shafer, P.</span><span class="refAuthor">, Watsen, K.</span><span class="refAuthor">, and R. Wilton</span>, <span class="refTitle">"Network Management Datastore Architecture (NMDA)"</span>, <span class="seriesInfo">RFC 8342</span>, <span class="seriesInfo">DOI 10.17487/RFC8342</span>, <time datetime="2018-03" class="refDate">March 2018</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8342">https://www.rfc-editor.org/info/rfc8342</a>&gt;</span>. </dd>
2087 <dd class="break"></dd>
2088 <dt id="RFC8407">[RFC8407]</dt>
2089 <dd>
2090 <span class="refAuthor">Bierman, A.</span>, <span class="refTitle">"Guidelines for Authors and Reviewers of Documents Containing YANG Data Models"</span>, <span class="seriesInfo">BCP 216</span>, <span class="seriesInfo">RFC 8407</span>, <span class="seriesInfo">DOI 10.17487/RFC8407</span>, <time datetime="2018-10" class="refDate">October 2018</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8407">https://www.rfc-editor.org/info/rfc8407</a>&gt;</span>. </dd>
2091 <dd class="break"></dd>
2092 </dl>
2093 </section>
2094 <section id="section-9.2">
2095 <h3 id="name-informative-references">
2096 <a href="#section-9.2" class="section-number selfRef">9.2. </a><a href="#name-informative-references" class="section-name selfRef">Informative References</a>
2097 </h3>
2098 <dl class="references">
2099 <dt id="RFC3688">[RFC3688]</dt>
2100 <dd>
2101 <span class="refAuthor">Mealling, M.</span>, <span class="refTitle">"The IETF XML Registry"</span>, <span class="seriesInfo">BCP 81</span>, <span class="seriesInfo">RFC 3688</span>, <span class="seriesInfo">DOI 10.17487/RFC3688</span>, <time datetime="2004-01" class="refDate">January 2004</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc3688">https://www.rfc-editor.org/info/rfc3688</a>&gt;</span>. </dd>
2102 <dd class="break"></dd>
2103 <dt id="RFC5198">[RFC5198]</dt>
2104 <dd>
2105 <span class="refAuthor">Klensin, J.</span><span class="refAuthor"> and M. Padlipsky</span>, <span class="refTitle">"Unicode Format for Network Interchange"</span>, <span class="seriesInfo">RFC 5198</span>, <span class="seriesInfo">DOI 10.17487/RFC5198</span>, <time datetime="2008-03" class="refDate">March 2008</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc5198">https://www.rfc-editor.org/info/rfc5198</a>&gt;</span>. </dd>
2106 <dd class="break"></dd>
2107 <dt id="RFC6020">[RFC6020]</dt>
2108 <dd>
2109 <span class="refAuthor">Bjorklund, M., Ed.</span>, <span class="refTitle">"YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"</span>, <span class="seriesInfo">RFC 6020</span>, <span class="seriesInfo">DOI 10.17487/RFC6020</span>, <time datetime="2010-10" class="refDate">October 2010</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6020">https://www.rfc-editor.org/info/rfc6020</a>&gt;</span>. </dd>
2110 <dd class="break"></dd>
2111 <dt id="RFC6241">[RFC6241]</dt>
2112 <dd>
2113 <span class="refAuthor">Enns, R., Ed.</span><span class="refAuthor">, Bjorklund, M., Ed.</span><span class="refAuthor">, Schoenwaelder, J., Ed.</span><span class="refAuthor">, and A. Bierman, Ed.</span>, <span class="refTitle">"Network Configuration Protocol (NETCONF)"</span>, <span class="seriesInfo">RFC 6241</span>, <span class="seriesInfo">DOI 10.17487/RFC6241</span>, <time datetime="2011-06" class="refDate">June 2011</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6241">https://www.rfc-editor.org/info/rfc6241</a>&gt;</span>. </dd>
2114 <dd class="break"></dd>
2115 <dt id="RFC6242">[RFC6242]</dt>
2116 <dd>
2117 <span class="refAuthor">Wasserman, M.</span>, <span class="refTitle">"Using the NETCONF Protocol over Secure Shell (SSH)"</span>, <span class="seriesInfo">RFC 6242</span>, <span class="seriesInfo">DOI 10.17487/RFC6242</span>, <time datetime="2011-06" class="refDate">June 2011</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6242">https://www.rfc-editor.org/info/rfc6242</a>&gt;</span>. </dd>
2118 <dd class="break"></dd>
2119 <dt id="RFC8340">[RFC8340]</dt>
2120 <dd>
2121 <span class="refAuthor">Bjorklund, M.</span><span class="refAuthor"> and L. Berger, Ed.</span>, <span class="refTitle">"YANG Tree Diagrams"</span>, <span class="seriesInfo">BCP 215</span>, <span class="seriesInfo">RFC 8340</span>, <span class="seriesInfo">DOI 10.17487/RFC8340</span>, <time datetime="2018-03" class="refDate">March 2018</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8340">https://www.rfc-editor.org/info/rfc8340</a>&gt;</span>. </dd>
2122 <dd class="break"></dd>
2123 </dl>
2124 </section>
2125 </section>
2126 <section id="section-appendix.a">
2127 <h2 id="name-examples">
2128 <a href="#section-appendix.a" class="section-number selfRef">Appendix A. </a><a href="#name-examples" class="section-name selfRef">Examples</a>
2129 </h2>
2130 <p id="section-appendix.a-1">The following is a fictional NETCONF example result from a query of
2131 the module tags list. For the sake of brevity, only a few module results
2132 are shown.<a href="#section-appendix.a-1" class="pilcrow">¶</a></p>
2133 <span id="name-example-netconf-query-outpu"></span><div id="sec-example-netconf-query-output">
2134 <figure id="figure-3">
2135 <div id="section-appendix.a-2.1">
2136 <pre class="sourcecode lang-xml">
2137 &lt;ns0:data xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0"&gt;
2138 &lt;t:module-tags
2139 xmlns:t="urn:ietf:params:xml:ns:yang:ietf-module-tags"&gt;
2140 &lt;t:module&gt;
2141 &lt;t:name&gt;ietf-bfd&lt;/t:name&gt;
2142 &lt;t:tag&gt;ietf:network-element-class&lt;/t:tag&gt;
2143 &lt;t:tag&gt;ietf:oam&lt;/t:tag&gt;
2144 &lt;t:tag&gt;ietf:protocol&lt;/t:tag&gt;
2145 &lt;t:tag&gt;ietf:sdo-defined-class&lt;/t:tag&gt;
2146 &lt;/t:module&gt;
2147 &lt;t:module&gt;
2148 &lt;t:name&gt;ietf-isis&lt;/t:name&gt;
2149 &lt;t:tag&gt;ietf:network-element-class&lt;/t:tag&gt;
2150 &lt;t:tag&gt;ietf:protocol&lt;/t:tag&gt;
2151 &lt;t:tag&gt;ietf:sdo-defined-class&lt;/t:tag&gt;
2152 &lt;t:tag&gt;ietf:routing&lt;/t:tag&gt;
2153 &lt;/t:module&gt;
2154 &lt;t:module&gt;
2155 &lt;t:name&gt;ietf-ssh-server&lt;/t:name&gt;
2156 &lt;t:tag&gt;ietf:network-element-class&lt;/t:tag&gt;
2157 &lt;t:tag&gt;ietf:protocol&lt;/t:tag&gt;
2158 &lt;t:tag&gt;ietf:sdo-defined-class&lt;/t:tag&gt;
2159 &lt;t:tag&gt;ietf:system-management&lt;/t:tag&gt;
2160 &lt;/t:module&gt;
2161 &lt;/t:module-tags&gt;
2162 &lt;/ns0:data&gt;
2163 </pre>
2164 </div>
2165 <figcaption><a href="#figure-3" class="selfRef">Figure 3</a>:
2166 <a href="#name-example-netconf-query-outpu" class="selfRef">Example NETCONF Query Output</a>
2167 </figcaption></figure>
2168 </div>
2169 </section>
2170 <section id="section-appendix.b">
2171 <h2 id="name-non-nmda-state-module">
2172 <a href="#section-appendix.b" class="section-number selfRef">Appendix B. </a><a href="#name-non-nmda-state-module" class="section-name selfRef">Non-NMDA State Module</a>
2173 </h2>
2174 <p id="section-appendix.b-1">As per <span>[<a href="#RFC8407" class="xref">RFC8407</a>]</span>, the following is a
2175 non-NMDA module to support viewing the operational state for non-NMDA
2176 compliant servers.<a href="#section-appendix.b-1" class="pilcrow">¶</a></p>
2177 <span id="name-non-nmda-module-tags-state-"></span><div id="sec-non-nmda-module-tags-state-module">
2178 <figure id="figure-4">
2179 <div id="section-appendix.b-2.1">
2180 <pre class="sourcecode lang-yang">&lt;CODE BEGINS&gt; file "[email protected]"
2181
2182 module ietf-module-tags-state {
2183 yang-version 1.1;
2184 namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags-state";
2185 prefix tags-s;
2186
2187 import ietf-yang-types {
2188 prefix yang;
2189 }
2190 import ietf-module-tags {
2191 prefix tags;
2192 }
2193
2194 organization
2195 "IETF NetMod Working Group (NetMod)";
2196 contact
2197 "WG Web: &lt;https://datatracker.ietf.org/wg/netmod/&gt;
2198 WG List: &lt;mailto:[email protected]&gt;
2199
2200 Author: Christian Hopps
2201 &lt;mailto:[email protected]&gt;
2202
2203 Author: Lou Berger
2204 &lt;mailto:[email protected]&gt;
2205
2206 Author: Dean Bogdanovic
2207 &lt;mailto:[email protected]&gt;";
2208
2209 description
2210 "This module describes a mechanism associating tags with YANG
2211 modules. Tags may be IANA assigned or privately defined.
2212
2213 This is a temporary non-NMDA module that is for use by
2214 implementations that don't yet support NMDA.
2215
2216 Copyright (c) 2021 IETF Trust and the persons identified as
2217 authors of the code. All rights reserved.
2218
2219 Redistribution and use in source and binary forms, with or
2220 without modification, is permitted pursuant to, and subject to
2221 the license terms contained in, the Simplified BSD License set
2222 forth in Section 4.c of the IETF Trust's Legal Provisions
2223 Relating to IETF Documents
2224 (https://trustee.ietf.org/license-info).
2225
2226 This version of this YANG module is part of RFC 8819
2227 (https://www.rfc-editor.org/info/rfc8819); see the RFC itself
2228 for full legal notices.";
2229
2230 revision 2021-01-04 {
2231 description
2232 "Initial revision.";
2233 reference
2234 "RFC 8819: YANG Module Tags";
2235 }
2236
2237 container module-tags-state {
2238 config false;
2239 status deprecated;
2240 description
2241 "Contains the list of modules and their associated tags.";
2242 list module {
2243 key "name";
2244 status deprecated;
2245 description
2246 "A list of modules and their associated tags.";
2247 leaf name {
2248 type yang:yang-identifier;
2249 mandatory true;
2250 status deprecated;
2251 description
2252 "The YANG module name.";
2253 }
2254 leaf-list tag {
2255 type tags:tag;
2256 status deprecated;
2257 description
2258 "Tags associated with the module. See the IANA 'YANG
2259 Module Tag Prefixes' registry for reserved prefixes and
2260 the IANA 'IETF YANG Module Tags' registry for IETF tags.
2261
2262 The contents of this list is constructed using the
2263 following steps:
2264
2265 1) System tags (i.e., tags of added by the system) are
2266 added.
2267 2) User-configured tags (i.e., tags added by
2268 configuration) are added.
2269 3) Any tag that is equal to a masked-tag present in the
2270 corresponding ietf-module-tags:module-tags:module-tag leaf
2271 list for this module is removed.";
2272 }
2273 }
2274 }
2275 }
2276
2277 &lt;CODE ENDS&gt;</pre>
2278 </div>
2279 <figcaption><a href="#figure-4" class="selfRef">Figure 4</a>:
2280 <a href="#name-non-nmda-module-tags-state-" class="selfRef">Non-NMDA Module Tags State Module</a>
2281 </figcaption></figure>
2282 </div>
2283 </section>
2284 <section id="section-appendix.c">
2285 <h2 id="name-acknowledgements">
2286 <a href="#name-acknowledgements" class="section-name selfRef">Acknowledgements</a>
2287 </h2>
2288 <p id="section-appendix.c-1">Special thanks to <span class="contact-name">Robert Wilton</span> for his help
2289 improving the introduction and providing the example use cases, as well
2290 as generating the non-NMDA module.<a href="#section-appendix.c-1" class="pilcrow">¶</a></p>
2291 </section>
2292 <div id="authors-addresses">
2293 <section id="section-appendix.d">
2294 <h2 id="name-authors-addresses">
2295 <a href="#name-authors-addresses" class="section-name selfRef">Authors' Addresses</a>
2296 </h2>
2297 <address class="vcard">
2298 <div dir="auto" class="left"><span class="fn nameRole">Christian Hopps</span></div>
2299 <div dir="auto" class="left"><span class="org">LabN Consulting, L.L.C.</span></div>
2300 <div class="email">
2301 <span>Email:</span>
2302 <a href="mailto:[email protected]" class="email">[email protected]</a>
2303 </div>
2304 </address>
2305 <address class="vcard">
2306 <div dir="auto" class="left"><span class="fn nameRole">Lou Berger</span></div>
2307 <div dir="auto" class="left"><span class="org">LabN Consulting, L.L.C.</span></div>
2308 <div class="email">
2309 <span>Email:</span>
2310 <a href="mailto:[email protected]" class="email">[email protected]</a>
2311 </div>
2312 </address>
2313 <address class="vcard">
2314 <div dir="auto" class="left"><span class="fn nameRole">Dean Bogdanovic</span></div>
2315 <div dir="auto" class="left"><span class="org">Volta Networks</span></div>
2316 <div class="email">
2317 <span>Email:</span>
2318 <a href="mailto:[email protected]" class="email">[email protected]</a>
2319 </div>
2320 </address>
2321 </section>
2322 </div>
2323 <script>const toc = document.getElementById("toc");
2324 toc.querySelector("h2").addEventListener("click", e => {
2325 toc.classList.toggle("active");
2326 });
2327 toc.querySelector("nav").addEventListener("click", e => {
2328 toc.classList.remove("active");
2329 });
2330 </script>
2331 </body>
2332 </html>