Debian Codegraph @

rfc8344.html

raw
1 <pre>Internet Engineering Task Force (IETF) M. Bjorklund
2 Request for Comments: 8344 Tail-f Systems
3 Obsoletes: <a href="./rfc7277">7277</a> March 2018
4 Category: Standards Track
5 ISSN: 2070-1721
6
7
8 <span class="h1">A YANG Data Model for IP Management</span>
9
10 Abstract
11
12 This document defines a YANG data model for management of IP
13 implementations. The data model includes configuration and system
14 state.
15
16 The YANG data model in this document conforms to the Network
17 Management Datastore Architecture defined in <a href="./rfc8342">RFC 8342</a>.
18
19 This document obsoletes <a href="./rfc7277">RFC 7277</a>.
20
21 Status of This Memo
22
23 This is an Internet Standards Track document.
24
25 This document is a product of the Internet Engineering Task Force
26 (IETF). It represents the consensus of the IETF community. It has
27 received public review and has been approved for publication by the
28 Internet Engineering Steering Group (IESG). Further information on
29 Internet Standards is available in <a href="./rfc7841#section-2">Section&nbsp;2 of RFC 7841</a>.
30
31 Information about the current status of this document, any errata,
32 and how to provide feedback on it may be obtained at
33 <a href="https://www.rfc-editor.org/info/rfc8344">https://www.rfc-editor.org/info/rfc8344</a>.
34
35 Copyright Notice
36
37 Copyright (c) 2018 IETF Trust and the persons identified as the
38 document authors. All rights reserved.
39
40 This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
41 Provisions Relating to IETF Documents
42 (<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of
43 publication of this document. Please review these documents
44 carefully, as they describe your rights and restrictions with respect
45 to this document. Code Components extracted from this document must
46 include Simplified BSD License text as described in Section 4.e of
47 the Trust Legal Provisions and are provided without warranty as
48 described in the Simplified BSD License.
49
50
51
52 <span class="grey">Bjorklund Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
55
56
57 Table of Contents
58
59 <a href="#section-1">1</a>. Introduction ....................................................<a href="#page-2">2</a>
60 <a href="#section-1.1">1.1</a>. Summary of Changes from <a href="./rfc7277">RFC 7277</a> ...........................<a href="#page-2">2</a>
61 <a href="#section-1.2">1.2</a>. Terminology ................................................<a href="#page-3">3</a>
62 <a href="#section-1.3">1.3</a>. Tree Diagrams ..............................................<a href="#page-3">3</a>
63 <a href="#section-2">2</a>. IP Data Model ...................................................<a href="#page-4">4</a>
64 <a href="#section-3">3</a>. Relationship to the IP-MIB ......................................<a href="#page-5">5</a>
65 <a href="#section-4">4</a>. IP Management YANG Module .......................................<a href="#page-7">7</a>
66 <a href="#section-5">5</a>. IANA Considerations ............................................<a href="#page-27">27</a>
67 <a href="#section-6">6</a>. Security Considerations ........................................<a href="#page-27">27</a>
68 <a href="#section-7">7</a>. References .....................................................<a href="#page-29">29</a>
69 <a href="#section-7.1">7.1</a>. Normative References ......................................<a href="#page-29">29</a>
70 <a href="#section-7.2">7.2</a>. Informative References ....................................<a href="#page-31">31</a>
71 <a href="#appendix-A">Appendix A</a>. Example: NETCONF &lt;get-config&gt; Reply ...................<a href="#page-32">32</a>
72 <a href="#appendix-B">Appendix B</a>. Example: NETCONF &lt;get-data&gt; Reply .....................<a href="#page-33">33</a>
73 Acknowledgments ...................................................<a href="#page-34">34</a>
74 Author's Address ..................................................<a href="#page-34">34</a>
75
76 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
77
78 This document defines a YANG data model [<a href="./rfc7950" title="&quot;The YANG 1.1 Data Modeling Language&quot;">RFC7950</a>] for management of
79 IP implementations.
80
81 The data model covers configuration of per-interface IPv4 and IPv6
82 parameters as well as mappings of IP addresses to link-layer
83 addresses. It also provides information about which IP addresses are
84 operationally used and which link-layer mappings exist.
85 Per-interface parameters are added through augmentation of the
86 interface data model defined in [<a href="./rfc8343" title="&quot;A YANG Data Model for Interface Management&quot;">RFC8343</a>].
87
88 This version of the IP data model supports the Network Management
89 Datastore Architecture (NMDA) [<a href="./rfc8342" title="&quot;Network Management Datastore Architecture (NMDA)&quot;">RFC8342</a>].
90
91 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Summary of Changes from <a href="./rfc7277">RFC 7277</a></span>
92
93 The "ipv4" and "ipv6" subtrees with "config false" data nodes in the
94 "/interfaces-state/interface" subtree are deprecated. All
95 "config false" data nodes are now present in the "ipv4" and "ipv6"
96 subtrees in the "/interfaces/interface" subtree.
97
98 Servers that do not implement NMDA or that wish to support clients
99 that do not implement NMDA MAY implement the deprecated "ipv4" and
100 "ipv6" subtrees in the "/interfaces-state/interface" subtree.
101
102
103
104
105
106
107
108 <span class="grey">Bjorklund Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
111
112
113 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Terminology</span>
114
115 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
116 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
117 "OPTIONAL" in this document are to be interpreted as described in
118 <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>] [<a href="./rfc8174" title="&quot;Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words&quot;">RFC8174</a>] when, and only when, they appear in all
119 capitals, as shown here.
120
121 The following terms are defined in [<a href="./rfc8342" title="&quot;Network Management Datastore Architecture (NMDA)&quot;">RFC8342</a>] and are not redefined
122 here:
123
124 o client
125
126 o server
127
128 o configuration
129
130 o system state
131
132 o intended configuration
133
134 o running configuration datastore
135
136 o operational state
137
138 o operational state datastore
139
140 The following terms are defined in [<a href="./rfc7950" title="&quot;The YANG 1.1 Data Modeling Language&quot;">RFC7950</a>] and are not redefined
141 here:
142
143 o augment
144
145 o data model
146
147 o data node
148
149 The terminology for describing YANG data models is found in
150 [<a href="./rfc7950" title="&quot;The YANG 1.1 Data Modeling Language&quot;">RFC7950</a>].
151
152 <span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>. Tree Diagrams</span>
153
154 Tree diagrams used in this document follow the notation defined in
155 [<a href="./rfc8340" title="&quot;YANG Tree Diagrams&quot;">RFC8340</a>].
156
157
158
159
160
161
162
163
164 <span class="grey">Bjorklund Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
167
168
169 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. IP Data Model</span>
170
171 This document defines the YANG module "ietf-ip", which augments the
172 "interface" lists defined in the "ietf-interfaces" module [<a href="./rfc8343" title="&quot;A YANG Data Model for Interface Management&quot;">RFC8343</a>]
173 with IP-specific data nodes.
174
175 The data model has the following structure for IP data nodes per
176 interface, excluding the deprecated data nodes:
177
178 module: ietf-ip
179 augment /if:interfaces/if:interface:
180 +--rw ipv4!
181 | +--rw enabled? boolean
182 | +--rw forwarding? boolean
183 | +--rw mtu? uint16
184 | +--rw address* [ip]
185 | | +--rw ip inet:ipv4-address-no-zone
186 | | +--rw (subnet)
187 | | | +--:(prefix-length)
188 | | | | +--rw prefix-length? uint8
189 | | | +--:(netmask)
190 | | | +--rw netmask? yang:dotted-quad
191 | | | {ipv4-non-contiguous-netmasks}?
192 | | +--ro origin? ip-address-origin
193 | +--rw neighbor* [ip]
194 | +--rw ip inet:ipv4-address-no-zone
195 | +--rw link-layer-address yang:phys-address
196 | +--ro origin? neighbor-origin
197 +--rw ipv6!
198 +--rw enabled? boolean
199 +--rw forwarding? boolean
200 +--rw mtu? uint32
201 +--rw address* [ip]
202 | +--rw ip inet:ipv6-address-no-zone
203 | +--rw prefix-length uint8
204 | +--ro origin? ip-address-origin
205 | +--ro status? enumeration
206 +--rw neighbor* [ip]
207 | +--rw ip inet:ipv6-address-no-zone
208 | +--rw link-layer-address yang:phys-address
209 | +--ro origin? neighbor-origin
210 | +--ro is-router? empty
211 | +--ro state? enumeration
212 +--rw dup-addr-detect-transmits? uint32
213
214
215
216
217
218
219
220 <span class="grey">Bjorklund Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
223
224
225 +--rw autoconf
226 +--rw create-global-addresses? boolean
227 +--rw create-temporary-addresses? boolean
228 | {ipv6-privacy-autoconf}?
229 +--rw temporary-valid-lifetime? uint32
230 | {ipv6-privacy-autoconf}?
231 +--rw temporary-preferred-lifetime? uint32
232 {ipv6-privacy-autoconf}?
233
234 The data model defines two containers per interface -- "ipv4" and
235 "ipv6", representing the IPv4 and IPv6 address families. In each
236 container, there is a leaf "enabled" that controls whether or not the
237 address family is enabled on that interface, and a leaf "forwarding"
238 that controls whether or not IP packet forwarding for the address
239 family is enabled on the interface. In each container, there is also
240 a list of addresses and a list of mappings from IP addresses to
241 link-layer addresses.
242
243 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Relationship to the IP-MIB</span>
244
245 If the device implements the IP-MIB [<a href="./rfc4293" title="&quot;Management Information Base for the Internet Protocol (IP)&quot;">RFC4293</a>], each entry in the
246 "ipv4/address" and "ipv6/address" lists is mapped to one
247 ipAddressEntry, where the ipAddressIfIndex refers to the "address"
248 entry's interface.
249
250 The IP-MIB defines objects to control IPv6 Router Advertisement
251 messages. The corresponding YANG data nodes are defined in
252 [<a href="./rfc8022" title="&quot;A YANG Data Model for Routing Management&quot;">RFC8022</a>].
253
254 The entries in "ipv4/neighbor" and "ipv6/neighbor" are mapped to
255 ipNetToPhysicalTable.
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276 <span class="grey">Bjorklund Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
279
280
281 The following table lists the YANG data nodes with corresponding
282 objects in the IP-MIB.
283
284 +----------------------------------+--------------------------------+
285 | YANG data node in | IP-MIB object |
286 | /if:interfaces/if:interface | |
287 +----------------------------------+--------------------------------+
288 | ipv4 | ipv4InterfaceEnableStatus |
289 | ipv4/enabled | ipv4InterfaceEnableStatus |
290 | ipv4/address | ipAddressEntry |
291 | ipv4/address/ip | ipAddressAddrType |
292 | | ipAddressAddr |
293 | ipv4/neighbor | ipNetToPhysicalEntry |
294 | ipv4/neighbor/ip | ipNetToPhysicalNetAddressType |
295 | | ipNetToPhysicalNetAddress |
296 | ipv4/neighbor/link-layer-address | ipNetToPhysicalPhysAddress |
297 | ipv4/neighbor/origin | ipNetToPhysicalType |
298 | ipv6 | ipv6InterfaceEnableStatus |
299 | ipv6/enabled | ipv6InterfaceEnableStatus |
300 | ipv6/forwarding | ipv6InterfaceForwarding |
301 | ipv6/address | ipAddressEntry |
302 | ipv6/address/ip | ipAddressAddrType |
303 | | ipAddressAddr |
304 | ipv4/address/origin | ipAddressOrigin |
305 | ipv6/address/status | ipAddressStatus |
306 | ipv6/neighbor | ipNetToPhysicalEntry |
307 | ipv6/neighbor/ip | ipNetToPhysicalNetAddressType |
308 | | ipNetToPhysicalNetAddress |
309 | ipv6/neighbor/link-layer-address | ipNetToPhysicalPhysAddress |
310 | ipv6/neighbor/origin | ipNetToPhysicalType |
311 | ipv6/neighbor/state | ipNetToPhysicalState |
312 +----------------------------------+--------------------------------+
313
314 YANG Interface Data Nodes and Related IP-MIB Objects
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332 <span class="grey">Bjorklund Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
335
336
337 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. IP Management YANG Module</span>
338
339 This module imports typedefs from [<a href="./rfc6991" title="&quot;Common YANG Data Types&quot;">RFC6991</a>] and [<a href="./rfc8343" title="&quot;A YANG Data Model for Interface Management&quot;">RFC8343</a>], and it
340 references [<a href="./rfc791" title="&quot;Internet Protocol&quot;">RFC791</a>], [<a href="./rfc826" title="&quot;An Ethernet Address Resolution Protocol: Or Converting Network Protocol Addresses to 48.bit Ethernet Address for Transmission on Ethernet Hardware&quot;">RFC826</a>], [<a href="./rfc4861" title="&quot;Neighbor Discovery for IP version 6 (IPv6)&quot;">RFC4861</a>], [<a href="./rfc4862" title="&quot;IPv6 Stateless Address Autoconfiguration&quot;">RFC4862</a>], [<a href="./rfc4941" title="&quot;Privacy Extensions for Stateless Address Autoconfiguration in IPv6&quot;">RFC4941</a>],
341 [<a href="./rfc7217" title="&quot;A Method for Generating Semantically Opaque Interface Identifiers with IPv6 Stateless Address Autoconfiguration (SLAAC)&quot;">RFC7217</a>], and [<a href="./rfc8200" title="&quot;Internet Protocol, Version 6 (IPv6) Specification&quot;">RFC8200</a>].
342
343 &lt;CODE BEGINS&gt; file "[email protected]"
344 module ietf-ip {
345 yang-version 1.1;
346 namespace "urn:ietf:params:xml:ns:yang:ietf-ip";
347 prefix ip;
348
349 import ietf-interfaces {
350 prefix if;
351 }
352 import ietf-inet-types {
353 prefix inet;
354 }
355 import ietf-yang-types {
356 prefix yang;
357 }
358
359 organization
360 "IETF NETMOD (Network Modeling) Working Group";
361
362 contact
363 "WG Web: &lt;<a href="https://datatracker.ietf.org/wg/netmod/">https://datatracker.ietf.org/wg/netmod/</a>&gt;
364 WG List: &lt;mailto:[email protected]&gt;
365
366 Editor: Martin Bjorklund
367 &lt;mailto:[email protected]&gt;";
368 description
369 "This module contains a collection of YANG definitions for
370 managing IP implementations.
371
372 Copyright (c) 2018 IETF Trust and the persons identified as
373 authors of the code. All rights reserved.
374
375 Redistribution and use in source and binary forms, with or
376 without modification, is permitted pursuant to, and subject
377 to the license terms contained in, the Simplified BSD License
378 set forth in <a href="#section-4">Section 4</a>.c of the IETF Trust's Legal Provisions
379 Relating to IETF Documents
380 (<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>).
381
382 This version of this YANG module is part of <a href="./rfc8344">RFC 8344</a>; see
383 the RFC itself for full legal notices.";
384
385
386
387
388 <span class="grey">Bjorklund Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
391
392
393 revision 2018-02-22 {
394 description
395 "Updated to support NMDA.";
396 reference
397 "<a href="./rfc8344">RFC 8344</a>: A YANG Data Model for IP Management";
398 }
399
400 revision 2014-06-16 {
401 description
402 "Initial revision.";
403 reference
404 "<a href="./rfc7277">RFC 7277</a>: A YANG Data Model for IP Management";
405 }
406
407 /*
408 * Features
409 */
410
411 feature ipv4-non-contiguous-netmasks {
412 description
413 "Indicates support for configuring non-contiguous
414 subnet masks.";
415 }
416
417 feature ipv6-privacy-autoconf {
418 description
419 "Indicates support for privacy extensions for stateless address
420 autoconfiguration in IPv6.";
421 reference
422 "<a href="./rfc4941">RFC 4941</a>: Privacy Extensions for Stateless Address
423 Autoconfiguration in IPv6";
424 }
425
426 /*
427 * Typedefs
428 */
429
430 typedef ip-address-origin {
431 type enumeration {
432 enum other {
433 description
434 "None of the following.";
435 }
436
437
438
439
440
441
442
443
444 <span class="grey">Bjorklund Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
447
448
449 enum static {
450 description
451 "Indicates that the address has been statically
452 configured -- for example, using the Network Configuration
453 Protocol (NETCONF) or a command line interface.";
454 }
455 enum dhcp {
456 description
457 "Indicates an address that has been assigned to this
458 system by a DHCP server.";
459 }
460 enum link-layer {
461 description
462 "Indicates an address created by IPv6 stateless
463 autoconfiguration that embeds a link-layer address in its
464 interface identifier.";
465 }
466 enum random {
467 description
468 "Indicates an address chosen by the system at
469 random, e.g., an IPv4 address within 169.254/16, a
470 temporary address as described in <a href="./rfc4941">RFC 4941</a>, or a
471 semantically opaque address as described in <a href="./rfc7217">RFC 7217</a>.";
472 reference
473 "<a href="./rfc4941">RFC 4941</a>: Privacy Extensions for Stateless Address
474 Autoconfiguration in IPv6
475 <a href="./rfc7217">RFC 7217</a>: A Method for Generating Semantically Opaque
476 Interface Identifiers with IPv6 Stateless
477 Address Autoconfiguration (SLAAC)";
478 }
479 }
480 description
481 "The origin of an address.";
482 }
483
484 typedef neighbor-origin {
485 type enumeration {
486 enum other {
487 description
488 "None of the following.";
489 }
490 enum static {
491 description
492 "Indicates that the mapping has been statically
493 configured -- for example, using NETCONF or a command line
494 interface.";
495 }
496
497
498
499
500 <span class="grey">Bjorklund Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
503
504
505 enum dynamic {
506 description
507 "Indicates that the mapping has been dynamically resolved
508 using, for example, IPv4 ARP or the IPv6 Neighbor
509 Discovery protocol.";
510 }
511 }
512 description
513 "The origin of a neighbor entry.";
514 }
515
516 /*
517 * Data nodes
518 */
519
520 augment "/if:interfaces/if:interface" {
521 description
522 "IP parameters on interfaces.
523
524 If an interface is not capable of running IP, the server
525 must not allow the client to configure these parameters.";
526
527 container ipv4 {
528 presence
529 "Enables IPv4 unless the 'enabled' leaf
530 (which defaults to 'true') is set to 'false'";
531 description
532 "Parameters for the IPv4 address family.";
533
534 leaf enabled {
535 type boolean;
536 default true;
537 description
538 "Controls whether IPv4 is enabled or disabled on this
539 interface. When IPv4 is enabled, this interface is
540 connected to an IPv4 stack, and the interface can send
541 and receive IPv4 packets.";
542 }
543 leaf forwarding {
544 type boolean;
545 default false;
546 description
547 "Controls IPv4 packet forwarding of datagrams received by,
548 but not addressed to, this interface. IPv4 routers
549 forward datagrams. IPv4 hosts do not (except those
550 source-routed via the host).";
551 }
552
553
554
555
556 <span class="grey">Bjorklund Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
559
560
561 leaf mtu {
562 type uint16 {
563 range "68..max";
564 }
565 units "octets";
566 description
567 "The size, in octets, of the largest IPv4 packet that the
568 interface will send and receive.
569
570 The server may restrict the allowed values for this leaf,
571 depending on the interface's type.
572
573 If this leaf is not configured, the operationally used MTU
574 depends on the interface's type.";
575 reference
576 "<a href="./rfc791">RFC 791</a>: Internet Protocol";
577 }
578 list address {
579 key "ip";
580 description
581 "The list of IPv4 addresses on the interface.";
582
583 leaf ip {
584 type inet:ipv4-address-no-zone;
585 description
586 "The IPv4 address on the interface.";
587 }
588 choice subnet {
589 mandatory true;
590 description
591 "The subnet can be specified as a prefix length or,
592 if the server supports non-contiguous netmasks, as
593 a netmask.";
594 leaf prefix-length {
595 type uint8 {
596 range "0..32";
597 }
598 description
599 "The length of the subnet prefix.";
600 }
601 leaf netmask {
602 if-feature ipv4-non-contiguous-netmasks;
603 type yang:dotted-quad;
604 description
605 "The subnet specified as a netmask.";
606 }
607 }
608
609
610
611
612 <span class="grey">Bjorklund Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
615
616
617 leaf origin {
618 type ip-address-origin;
619 config false;
620 description
621 "The origin of this address.";
622 }
623 }
624 list neighbor {
625 key "ip";
626 description
627 "A list of mappings from IPv4 addresses to
628 link-layer addresses.
629
630 Entries in this list in the intended configuration are
631 used as static entries in the ARP Cache.
632
633 In the operational state, this list represents the ARP
634 Cache.";
635 reference
636 "<a href="./rfc826">RFC 826</a>: An Ethernet Address Resolution Protocol";
637
638 leaf ip {
639 type inet:ipv4-address-no-zone;
640 description
641 "The IPv4 address of the neighbor node.";
642 }
643 leaf link-layer-address {
644 type yang:phys-address;
645 mandatory true;
646 description
647 "The link-layer address of the neighbor node.";
648 }
649 leaf origin {
650 type neighbor-origin;
651 config false;
652 description
653 "The origin of this neighbor entry.";
654 }
655 }
656 }
657
658
659
660
661
662
663
664
665
666
667
668 <span class="grey">Bjorklund Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
671
672
673 container ipv6 {
674 presence
675 "Enables IPv6 unless the 'enabled' leaf
676 (which defaults to 'true') is set to 'false'";
677 description
678 "Parameters for the IPv6 address family.";
679
680 leaf enabled {
681 type boolean;
682 default true;
683 description
684 "Controls whether IPv6 is enabled or disabled on this
685 interface. When IPv6 is enabled, this interface is
686 connected to an IPv6 stack, and the interface can send
687 and receive IPv6 packets.";
688 }
689 leaf forwarding {
690 type boolean;
691 default false;
692 description
693 "Controls IPv6 packet forwarding of datagrams received by,
694 but not addressed to, this interface. IPv6 routers
695 forward datagrams. IPv6 hosts do not (except those
696 source-routed via the host).";
697 reference
698 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)
699 <a href="#section-6.2.1">Section 6.2.1</a>, IsRouter";
700 }
701 leaf mtu {
702 type uint32 {
703 range "1280..max";
704 }
705 units "octets";
706 description
707 "The size, in octets, of the largest IPv6 packet that the
708 interface will send and receive.
709
710 The server may restrict the allowed values for this leaf,
711 depending on the interface's type.
712
713 If this leaf is not configured, the operationally used MTU
714 depends on the interface's type.";
715 reference
716 "<a href="./rfc8200">RFC 8200</a>: Internet Protocol, Version 6 (IPv6)
717 Specification
718 <a href="#section-5">Section 5</a>";
719 }
720
721
722
723
724 <span class="grey">Bjorklund Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
727
728
729 list address {
730 key "ip";
731 description
732 "The list of IPv6 addresses on the interface.";
733
734 leaf ip {
735 type inet:ipv6-address-no-zone;
736 description
737 "The IPv6 address on the interface.";
738 }
739 leaf prefix-length {
740 type uint8 {
741 range "0..128";
742 }
743 mandatory true;
744 description
745 "The length of the subnet prefix.";
746 }
747 leaf origin {
748 type ip-address-origin;
749 config false;
750 description
751 "The origin of this address.";
752 }
753 leaf status {
754 type enumeration {
755 enum preferred {
756 description
757 "This is a valid address that can appear as the
758 destination or source address of a packet.";
759 }
760 enum deprecated {
761 description
762 "This is a valid but deprecated address that should
763 no longer be used as a source address in new
764 communications, but packets addressed to such an
765 address are processed as expected.";
766 }
767 enum invalid {
768 description
769 "This isn't a valid address, and it shouldn't appear
770 as the destination or source address of a packet.";
771 }
772
773
774
775
776
777
778
779
780 <span class="grey">Bjorklund Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
783
784
785 enum inaccessible {
786 description
787 "The address is not accessible because the interface
788 to which this address is assigned is not
789 operational.";
790 }
791 enum unknown {
792 description
793 "The status cannot be determined for some reason.";
794 }
795 enum tentative {
796 description
797 "The uniqueness of the address on the link is being
798 verified. Addresses in this state should not be
799 used for general communication and should only be
800 used to determine the uniqueness of the address.";
801 }
802 enum duplicate {
803 description
804 "The address has been determined to be non-unique on
805 the link and so must not be used.";
806 }
807 enum optimistic {
808 description
809 "The address is available for use, subject to
810 restrictions, while its uniqueness on a link is
811 being verified.";
812 }
813 }
814 config false;
815 description
816 "The status of an address. Most of the states correspond
817 to states from the IPv6 Stateless Address
818 Autoconfiguration protocol.";
819 reference
820 "<a href="./rfc4293">RFC 4293</a>: Management Information Base for the
821 Internet Protocol (IP)
822 - IpAddressStatusTC
823 <a href="./rfc4862">RFC 4862</a>: IPv6 Stateless Address Autoconfiguration";
824 }
825 }
826
827
828
829
830
831
832
833
834
835
836 <span class="grey">Bjorklund Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
839
840
841 list neighbor {
842 key "ip";
843 description
844 "A list of mappings from IPv6 addresses to
845 link-layer addresses.
846
847 Entries in this list in the intended configuration are
848 used as static entries in the Neighbor Cache.
849
850 In the operational state, this list represents the
851 Neighbor Cache.";
852 reference
853 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)";
854
855 leaf ip {
856 type inet:ipv6-address-no-zone;
857 description
858 "The IPv6 address of the neighbor node.";
859 }
860 leaf link-layer-address {
861 type yang:phys-address;
862 mandatory true;
863 description
864 "The link-layer address of the neighbor node.
865
866 In the operational state, if the neighbor's 'state' leaf
867 is 'incomplete', this leaf is not instantiated.";
868 }
869 leaf origin {
870 type neighbor-origin;
871 config false;
872 description
873 "The origin of this neighbor entry.";
874 }
875 leaf is-router {
876 type empty;
877 config false;
878 description
879 "Indicates that the neighbor node acts as a router.";
880 }
881
882
883
884
885
886
887
888
889
890
891
892 <span class="grey">Bjorklund Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
895
896
897 leaf state {
898 type enumeration {
899 enum incomplete {
900 description
901 "Address resolution is in progress, and the
902 link-layer address of the neighbor has not yet been
903 determined.";
904 }
905 enum reachable {
906 description
907 "Roughly speaking, the neighbor is known to have been
908 reachable recently (within tens of seconds ago).";
909 }
910 enum stale {
911 description
912 "The neighbor is no longer known to be reachable, but
913 until traffic is sent to the neighbor no attempt
914 should be made to verify its reachability.";
915 }
916 enum delay {
917 description
918 "The neighbor is no longer known to be reachable, and
919 traffic has recently been sent to the neighbor.
920 Rather than probe the neighbor immediately, however,
921 delay sending probes for a short while in order to
922 give upper-layer protocols a chance to provide
923 reachability confirmation.";
924 }
925 enum probe {
926 description
927 "The neighbor is no longer known to be reachable, and
928 unicast Neighbor Solicitation probes are being sent
929 to verify reachability.";
930 }
931 }
932 config false;
933 description
934 "The Neighbor Unreachability Detection state of this
935 entry.";
936 reference
937 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)
938 <a href="#section-7.3.2">Section 7.3.2</a>";
939 }
940 }
941
942
943
944
945
946
947
948 <span class="grey">Bjorklund Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
951
952
953 leaf dup-addr-detect-transmits {
954 type uint32;
955 default 1;
956 description
957 "The number of consecutive Neighbor Solicitation messages
958 sent while performing Duplicate Address Detection on a
959 tentative address. A value of zero indicates that
960 Duplicate Address Detection is not performed on
961 tentative addresses. A value of one indicates a single
962 transmission with no follow-up retransmissions.";
963 reference
964 "<a href="./rfc4862">RFC 4862</a>: IPv6 Stateless Address Autoconfiguration";
965 }
966 container autoconf {
967 description
968 "Parameters to control the autoconfiguration of IPv6
969 addresses, as described in <a href="./rfc4862">RFC 4862</a>.";
970 reference
971 "<a href="./rfc4862">RFC 4862</a>: IPv6 Stateless Address Autoconfiguration";
972
973 leaf create-global-addresses {
974 type boolean;
975 default true;
976 description
977 "If enabled, the host creates global addresses as
978 described in <a href="./rfc4862">RFC 4862</a>.";
979 reference
980 "<a href="./rfc4862">RFC 4862</a>: IPv6 Stateless Address Autoconfiguration
981 <a href="#section-5.5">Section 5.5</a>";
982 }
983 leaf create-temporary-addresses {
984 if-feature ipv6-privacy-autoconf;
985 type boolean;
986 default false;
987 description
988 "If enabled, the host creates temporary addresses as
989 described in <a href="./rfc4941">RFC 4941</a>.";
990 reference
991 "<a href="./rfc4941">RFC 4941</a>: Privacy Extensions for Stateless Address
992 Autoconfiguration in IPv6";
993 }
994
995
996
997
998
999
1000
1001
1002
1003
1004 <span class="grey">Bjorklund Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1007
1008
1009 leaf temporary-valid-lifetime {
1010 if-feature ipv6-privacy-autoconf;
1011 type uint32;
1012 units "seconds";
1013 default 604800;
1014 description
1015 "The time period during which the temporary address
1016 is valid.";
1017 reference
1018 "<a href="./rfc4941">RFC 4941</a>: Privacy Extensions for Stateless Address
1019 Autoconfiguration in IPv6
1020 - TEMP_VALID_LIFETIME";
1021 }
1022 leaf temporary-preferred-lifetime {
1023 if-feature ipv6-privacy-autoconf;
1024 type uint32;
1025 units "seconds";
1026 default 86400;
1027 description
1028 "The time period during which the temporary address is
1029 preferred.";
1030 reference
1031 "<a href="./rfc4941">RFC 4941</a>: Privacy Extensions for Stateless Address
1032 Autoconfiguration in IPv6
1033 - TEMP_PREFERRED_LIFETIME";
1034 }
1035 }
1036 }
1037 }
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060 <span class="grey">Bjorklund Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1063
1064
1065 /*
1066 * Legacy operational state data nodes
1067 */
1068
1069 augment "/if:interfaces-state/if:interface" {
1070 status deprecated;
1071 description
1072 "Data nodes for the operational state of IP on interfaces.";
1073
1074 container ipv4 {
1075 presence
1076 "Present if IPv4 is enabled on this interface";
1077 config false;
1078 status deprecated;
1079 description
1080 "Interface-specific parameters for the IPv4 address family.";
1081
1082 leaf forwarding {
1083 type boolean;
1084 status deprecated;
1085 description
1086 "Indicates whether IPv4 packet forwarding is enabled or
1087 disabled on this interface.";
1088 }
1089 leaf mtu {
1090 type uint16 {
1091 range "68..max";
1092 }
1093 units "octets";
1094 status deprecated;
1095 description
1096 "The size, in octets, of the largest IPv4 packet that the
1097 interface will send and receive.";
1098 reference
1099 "<a href="./rfc791">RFC 791</a>: Internet Protocol";
1100 }
1101 list address {
1102 key "ip";
1103 status deprecated;
1104 description
1105 "The list of IPv4 addresses on the interface.";
1106
1107 leaf ip {
1108 type inet:ipv4-address-no-zone;
1109 status deprecated;
1110 description
1111 "The IPv4 address on the interface.";
1112 }
1113
1114
1115
1116 <span class="grey">Bjorklund Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1119
1120
1121 choice subnet {
1122 status deprecated;
1123 description
1124 "The subnet can be specified as a prefix length or,
1125 if the server supports non-contiguous netmasks, as
1126 a netmask.";
1127 leaf prefix-length {
1128 type uint8 {
1129 range "0..32";
1130 }
1131 status deprecated;
1132 description
1133 "The length of the subnet prefix.";
1134 }
1135 leaf netmask {
1136 if-feature ipv4-non-contiguous-netmasks;
1137 type yang:dotted-quad;
1138 status deprecated;
1139 description
1140 "The subnet specified as a netmask.";
1141 }
1142 }
1143 leaf origin {
1144 type ip-address-origin;
1145 status deprecated;
1146 description
1147 "The origin of this address.";
1148 }
1149 }
1150 list neighbor {
1151 key "ip";
1152 status deprecated;
1153 description
1154 "A list of mappings from IPv4 addresses to
1155 link-layer addresses.
1156
1157 This list represents the ARP Cache.";
1158 reference
1159 "<a href="./rfc826">RFC 826</a>: An Ethernet Address Resolution Protocol";
1160
1161 leaf ip {
1162 type inet:ipv4-address-no-zone;
1163 status deprecated;
1164 description
1165 "The IPv4 address of the neighbor node.";
1166 }
1167
1168
1169
1170
1171
1172 <span class="grey">Bjorklund Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1175
1176
1177 leaf link-layer-address {
1178 type yang:phys-address;
1179 status deprecated;
1180 description
1181 "The link-layer address of the neighbor node.";
1182 }
1183 leaf origin {
1184 type neighbor-origin;
1185 status deprecated;
1186 description
1187 "The origin of this neighbor entry.";
1188 }
1189 }
1190 }
1191
1192 container ipv6 {
1193 presence
1194 "Present if IPv6 is enabled on this interface";
1195 config false;
1196 status deprecated;
1197 description
1198 "Parameters for the IPv6 address family.";
1199
1200 leaf forwarding {
1201 type boolean;
1202 default false;
1203 status deprecated;
1204 description
1205 "Indicates whether IPv6 packet forwarding is enabled or
1206 disabled on this interface.";
1207 reference
1208 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)
1209 <a href="#section-6.2.1">Section 6.2.1</a>, IsRouter";
1210 }
1211 leaf mtu {
1212 type uint32 {
1213 range "1280..max";
1214 }
1215 units "octets";
1216 status deprecated;
1217 description
1218 "The size, in octets, of the largest IPv6 packet that the
1219 interface will send and receive.";
1220 reference
1221 "<a href="./rfc8200">RFC 8200</a>: Internet Protocol, Version 6 (IPv6)
1222 Specification
1223 <a href="#section-5">Section 5</a>";
1224 }
1225
1226
1227
1228 <span class="grey">Bjorklund Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1231
1232
1233 list address {
1234 key "ip";
1235 status deprecated;
1236 description
1237 "The list of IPv6 addresses on the interface.";
1238
1239 leaf ip {
1240 type inet:ipv6-address-no-zone;
1241 status deprecated;
1242 description
1243 "The IPv6 address on the interface.";
1244 }
1245 leaf prefix-length {
1246 type uint8 {
1247 range "0..128";
1248 }
1249 mandatory true;
1250 status deprecated;
1251 description
1252 "The length of the subnet prefix.";
1253 }
1254 leaf origin {
1255 type ip-address-origin;
1256 status deprecated;
1257 description
1258 "The origin of this address.";
1259 }
1260 leaf status {
1261 type enumeration {
1262 enum preferred {
1263 description
1264 "This is a valid address that can appear as the
1265 destination or source address of a packet.";
1266 }
1267 enum deprecated {
1268 description
1269 "This is a valid but deprecated address that should
1270 no longer be used as a source address in new
1271 communications, but packets addressed to such an
1272 address are processed as expected.";
1273 }
1274 enum invalid {
1275 description
1276 "This isn't a valid address, and it shouldn't appear
1277 as the destination or source address of a packet.";
1278 }
1279
1280
1281
1282
1283
1284 <span class="grey">Bjorklund Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1287
1288
1289 enum inaccessible {
1290 description
1291 "The address is not accessible because the interface
1292 to which this address is assigned is not
1293 operational.";
1294 }
1295 enum unknown {
1296 description
1297 "The status cannot be determined for some reason.";
1298 }
1299 enum tentative {
1300 description
1301 "The uniqueness of the address on the link is being
1302 verified. Addresses in this state should not be
1303 used for general communication and should only be
1304 used to determine the uniqueness of the address.";
1305 }
1306 enum duplicate {
1307 description
1308 "The address has been determined to be non-unique on
1309 the link and so must not be used.";
1310 }
1311 enum optimistic {
1312 description
1313 "The address is available for use, subject to
1314 restrictions, while its uniqueness on a link is
1315 being verified.";
1316 }
1317 }
1318 status deprecated;
1319 description
1320 "The status of an address. Most of the states correspond
1321 to states from the IPv6 Stateless Address
1322 Autoconfiguration protocol.";
1323 reference
1324 "<a href="./rfc4293">RFC 4293</a>: Management Information Base for the
1325 Internet Protocol (IP)
1326 - IpAddressStatusTC
1327 <a href="./rfc4862">RFC 4862</a>: IPv6 Stateless Address Autoconfiguration";
1328 }
1329 }
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340 <span class="grey">Bjorklund Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1343
1344
1345 list neighbor {
1346 key "ip";
1347 status deprecated;
1348 description
1349 "A list of mappings from IPv6 addresses to
1350 link-layer addresses.
1351
1352 This list represents the Neighbor Cache.";
1353 reference
1354 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)";
1355
1356 leaf ip {
1357 type inet:ipv6-address-no-zone;
1358 status deprecated;
1359 description
1360 "The IPv6 address of the neighbor node.";
1361 }
1362 leaf link-layer-address {
1363 type yang:phys-address;
1364 status deprecated;
1365 description
1366 "The link-layer address of the neighbor node.";
1367 }
1368 leaf origin {
1369 type neighbor-origin;
1370 status deprecated;
1371 description
1372 "The origin of this neighbor entry.";
1373 }
1374 leaf is-router {
1375 type empty;
1376 status deprecated;
1377 description
1378 "Indicates that the neighbor node acts as a router.";
1379 }
1380 leaf state {
1381 type enumeration {
1382 enum incomplete {
1383 description
1384 "Address resolution is in progress, and the
1385 link-layer address of the neighbor has not yet been
1386 determined.";
1387 }
1388 enum reachable {
1389 description
1390 "Roughly speaking, the neighbor is known to have been
1391 reachable recently (within tens of seconds ago).";
1392 }
1393
1394
1395
1396 <span class="grey">Bjorklund Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1399
1400
1401 enum stale {
1402 description
1403 "The neighbor is no longer known to be reachable, but
1404 until traffic is sent to the neighbor no attempt
1405 should be made to verify its reachability.";
1406 }
1407 enum delay {
1408 description
1409 "The neighbor is no longer known to be reachable, and
1410 traffic has recently been sent to the neighbor.
1411 Rather than probe the neighbor immediately, however,
1412 delay sending probes for a short while in order to
1413 give upper-layer protocols a chance to provide
1414 reachability confirmation.";
1415 }
1416 enum probe {
1417 description
1418 "The neighbor is no longer known to be reachable, and
1419 unicast Neighbor Solicitation probes are being sent
1420 to verify reachability.";
1421 }
1422 }
1423 status deprecated;
1424 description
1425 "The Neighbor Unreachability Detection state of this
1426 entry.";
1427 reference
1428 "<a href="./rfc4861">RFC 4861</a>: Neighbor Discovery for IP version 6 (IPv6)
1429 <a href="#section-7.3.2">Section 7.3.2</a>";
1430 }
1431 }
1432 }
1433 }
1434 }
1435 &lt;CODE ENDS&gt;
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <span class="grey">Bjorklund Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1455
1456
1457 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. IANA Considerations</span>
1458
1459 This document registers a URI in the "IETF XML Registry" [<a href="./rfc3688" title="&quot;The IETF XML Registry&quot;">RFC3688</a>].
1460 Following the format in <a href="./rfc3688">RFC 3688</a>, the following registration has been
1461 made.
1462
1463 URI: urn:ietf:params:xml:ns:yang:ietf-ip
1464 Registrant Contact: The NETMOD WG of the IETF.
1465 XML: N/A; the requested URI is an XML namespace.
1466
1467 This document registers a YANG module in the "YANG Module Names"
1468 registry [<a href="./rfc6020" title="&quot;YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)&quot;">RFC6020</a>].
1469
1470 Name: ietf-ip
1471 Namespace: urn:ietf:params:xml:ns:yang:ietf-ip
1472 Prefix: ip
1473 Reference: <a href="./rfc8344">RFC 8344</a>
1474
1475 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
1476
1477 The YANG module specified in this document defines a schema for data
1478 that is designed to be accessed via network management protocols such
1479 as NETCONF [<a href="./rfc6241" title="&quot;Network Configuration Protocol (NETCONF)&quot;">RFC6241</a>] or RESTCONF [<a href="./rfc8040" title="&quot;RESTCONF Protocol&quot;">RFC8040</a>]. The lowest NETCONF layer
1480 is the secure transport layer, and the mandatory-to-implement secure
1481 transport is Secure Shell (SSH) [<a href="./rfc6242" title="&quot;Using the NETCONF Protocol over Secure Shell (SSH)&quot;">RFC6242</a>]. The lowest RESTCONF layer
1482 is HTTPS, and the mandatory-to-implement secure transport is TLS
1483 [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>].
1484
1485 The NETCONF access control model [<a href="./rfc8341" title="&quot;Network Configuration Access Control Model&quot;">RFC8341</a>] provides the means to
1486 restrict access for particular NETCONF or RESTCONF users to a
1487 preconfigured subset of all available NETCONF or RESTCONF protocol
1488 operations and content.
1489
1490 There are a number of data nodes defined in this YANG module that are
1491 writable/creatable/deletable (i.e., config true, which is the
1492 default). These data nodes may be considered sensitive or vulnerable
1493 in some network environments. Write operations (e.g., edit-config)
1494 to these data nodes without proper protection can have a negative
1495 effect on network operations. These are the subtrees and data nodes
1496 and their sensitivity/vulnerability:
1497
1498 ipv4/enabled and ipv6/enabled: These leafs are used to enable or
1499 disable IPv4 and IPv6 on a specific interface. By enabling a
1500 protocol on an interface, an attacker might be able to create an
1501 unsecured path into a node (or through it if routing is also
1502 enabled). By disabling a protocol on an interface, an attacker
1503
1504
1505
1506
1507
1508 <span class="grey">Bjorklund Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1511
1512
1513 might be able to force packets to be routed through some other
1514 interface or deny access to some or all of the network via that
1515 protocol.
1516
1517 ipv4/address and ipv6/address: These lists specify the configured IP
1518 addresses on an interface. By modifying this information, an
1519 attacker can cause a node to either ignore messages destined to it
1520 or accept (at least at the IP layer) messages it would otherwise
1521 ignore. The use of filtering or security associations may reduce
1522 the potential damage in the latter case.
1523
1524 ipv4/forwarding and ipv6/forwarding: These leafs allow a client to
1525 enable or disable the forwarding functions on the entity. By
1526 disabling the forwarding functions, an attacker would possibly be
1527 able to deny service to users. By enabling the forwarding
1528 functions, an attacker could open a conduit into an area. This
1529 might result in the area providing transit for packets it
1530 shouldn't, or it might allow the attacker access to the area,
1531 bypassing security safeguards.
1532
1533 ipv6/autoconf: The leafs in this branch control the
1534 autoconfiguration of IPv6 addresses and, in particular, whether or
1535 not temporary addresses are used. By modifying the corresponding
1536 leafs, an attacker might impact the addresses used by a node and
1537 -- thus, indirectly -- the privacy of the users using the node.
1538
1539 ipv4/mtu and ipv6/mtu: Setting these leafs to very small values can
1540 be used to slow down interfaces.
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564 <span class="grey">Bjorklund Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1567
1568
1569 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
1570
1571 <span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
1572
1573 [<a id="ref-RFC791">RFC791</a>] Postel, J., "Internet Protocol", STD 5, <a href="./rfc791">RFC 791</a>,
1574 DOI 10.17487/RFC0791, September 1981,
1575 &lt;<a href="https://www.rfc-editor.org/info/rfc791">https://www.rfc-editor.org/info/rfc791</a>&gt;.
1576
1577 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
1578 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
1579 DOI 10.17487/RFC2119, March 1997,
1580 &lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;.
1581
1582 [<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
1583 DOI 10.17487/RFC3688, January 2004,
1584 &lt;<a href="https://www.rfc-editor.org/info/rfc3688">https://www.rfc-editor.org/info/rfc3688</a>&gt;.
1585
1586 [<a id="ref-RFC4861">RFC4861</a>] Narten, T., Nordmark, E., Simpson, W., and H. Soliman,
1587 "Neighbor Discovery for IP version 6 (IPv6)", <a href="./rfc4861">RFC 4861</a>,
1588 DOI 10.17487/RFC4861, September 2007,
1589 &lt;<a href="https://www.rfc-editor.org/info/rfc4861">https://www.rfc-editor.org/info/rfc4861</a>&gt;.
1590
1591 [<a id="ref-RFC4862">RFC4862</a>] Thomson, S., Narten, T., and T. Jinmei, "IPv6 Stateless
1592 Address Autoconfiguration", <a href="./rfc4862">RFC 4862</a>,
1593 DOI 10.17487/RFC4862, September 2007,
1594 &lt;<a href="https://www.rfc-editor.org/info/rfc4862">https://www.rfc-editor.org/info/rfc4862</a>&gt;.
1595
1596 [<a id="ref-RFC4941">RFC4941</a>] Narten, T., Draves, R., and S. Krishnan, "Privacy
1597 Extensions for Stateless Address Autoconfiguration in
1598 IPv6", <a href="./rfc4941">RFC 4941</a>, DOI 10.17487/RFC4941, September 2007,
1599 &lt;<a href="https://www.rfc-editor.org/info/rfc4941">https://www.rfc-editor.org/info/rfc4941</a>&gt;.
1600
1601 [<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
1602 (TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>,
1603 DOI 10.17487/RFC5246, August 2008,
1604 &lt;<a href="https://www.rfc-editor.org/info/rfc5246">https://www.rfc-editor.org/info/rfc5246</a>&gt;.
1605
1606 [<a id="ref-RFC6020">RFC6020</a>] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
1607 the Network Configuration Protocol (NETCONF)", <a href="./rfc6020">RFC 6020</a>,
1608 DOI 10.17487/RFC6020, October 2010,
1609 &lt;<a href="https://www.rfc-editor.org/info/rfc6020">https://www.rfc-editor.org/info/rfc6020</a>&gt;.
1610
1611 [<a id="ref-RFC6241">RFC6241</a>] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
1612 and A. Bierman, Ed., "Network Configuration Protocol
1613 (NETCONF)", <a href="./rfc6241">RFC 6241</a>, DOI 10.17487/RFC6241, June 2011,
1614 &lt;<a href="https://www.rfc-editor.org/info/rfc6241">https://www.rfc-editor.org/info/rfc6241</a>&gt;.
1615
1616
1617
1618
1619
1620 <span class="grey">Bjorklund Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1623
1624
1625 [<a id="ref-RFC6242">RFC6242</a>] Wasserman, M., "Using the NETCONF Protocol over Secure
1626 Shell (SSH)", <a href="./rfc6242">RFC 6242</a>, DOI 10.17487/RFC6242, June 2011,
1627 &lt;<a href="https://www.rfc-editor.org/info/rfc6242">https://www.rfc-editor.org/info/rfc6242</a>&gt;.
1628
1629 [<a id="ref-RFC6991">RFC6991</a>] Schoenwaelder, J., Ed., "Common YANG Data Types",
1630 <a href="./rfc6991">RFC 6991</a>, DOI 10.17487/RFC6991, July 2013,
1631 &lt;<a href="https://www.rfc-editor.org/info/rfc6991">https://www.rfc-editor.org/info/rfc6991</a>&gt;.
1632
1633 [<a id="ref-RFC7950">RFC7950</a>] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
1634 <a href="./rfc7950">RFC 7950</a>, DOI 10.17487/RFC7950, August 2016,
1635 &lt;<a href="https://www.rfc-editor.org/info/rfc7950">https://www.rfc-editor.org/info/rfc7950</a>&gt;.
1636
1637 [<a id="ref-RFC8040">RFC8040</a>] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
1638 Protocol", <a href="./rfc8040">RFC 8040</a>, DOI 10.17487/RFC8040, January 2017,
1639 &lt;<a href="https://www.rfc-editor.org/info/rfc8040">https://www.rfc-editor.org/info/rfc8040</a>&gt;.
1640
1641 [<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in
1642 <a href="./rfc2119">RFC 2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>,
1643 DOI 10.17487/RFC8174, May 2017,
1644 &lt;<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>&gt;.
1645
1646 [<a id="ref-RFC8200">RFC8200</a>] Deering, S. and R. Hinden, "Internet Protocol, Version 6
1647 (IPv6) Specification", STD 86, <a href="./rfc8200">RFC 8200</a>,
1648 DOI 10.17487/RFC8200, July 2017,
1649 &lt;<a href="https://www.rfc-editor.org/info/rfc8200">https://www.rfc-editor.org/info/rfc8200</a>&gt;.
1650
1651 [<a id="ref-RFC8341">RFC8341</a>] Bierman, A. and M. Bjorklund, "Network Configuration
1652 Access Control Model", STD 91, <a href="./rfc8341">RFC 8341</a>,
1653 DOI 10.17487/RFC8341, March 2018,
1654 &lt;<a href="https://www.rfc-editor.org/info/rfc8341">https://www.rfc-editor.org/info/rfc8341</a>&gt;.
1655
1656 [<a id="ref-RFC8342">RFC8342</a>] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
1657 and R. Wilton, "Network Management Datastore Architecture
1658 (NMDA)", <a href="./rfc8342">RFC 8342</a>, DOI 10.17487/RFC8342, March 2018,
1659 &lt;<a href="https://www.rfc-editor.org/info/rfc8342">https://www.rfc-editor.org/info/rfc8342</a>&gt;.
1660
1661 [<a id="ref-RFC8343">RFC8343</a>] Bjorklund, M., "A YANG Data Model for Interface
1662 Management", <a href="./rfc8343">RFC 8343</a>, DOI 10.17487/RFC8343, March 2018,
1663 &lt;<a href="https://www.rfc-editor.org/info/rfc8343">https://www.rfc-editor.org/info/rfc8343</a>&gt;.
1664
1665 [<a id="ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>]
1666 Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and
1667 F. Yergeau, "Extensible Markup Language (XML) 1.0
1668 (Fifth Edition)", World Wide Web Consortium Recommendation
1669 REC-xml-20081126, November 2008,
1670 &lt;<a href="https://www.w3.org/TR/2008/REC-xml-20081126">https://www.w3.org/TR/2008/REC-xml-20081126</a>&gt;.
1671
1672
1673
1674
1675
1676 <span class="grey">Bjorklund Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1679
1680
1681 <span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
1682
1683 [<a id="ref-RFC826">RFC826</a>] Plummer, D., "An Ethernet Address Resolution Protocol: Or
1684 Converting Network Protocol Addresses to 48.bit Ethernet
1685 Address for Transmission on Ethernet Hardware", STD 37,
1686 <a href="./rfc826">RFC 826</a>, DOI 10.17487/RFC0826, November 1982,
1687 &lt;<a href="https://www.rfc-editor.org/info/rfc826">https://www.rfc-editor.org/info/rfc826</a>&gt;.
1688
1689 [<a id="ref-RFC4293">RFC4293</a>] Routhier, S., Ed., "Management Information Base for the
1690 Internet Protocol (IP)", <a href="./rfc4293">RFC 4293</a>, DOI 10.17487/RFC4293,
1691 April 2006, &lt;<a href="https://www.rfc-editor.org/info/rfc4293">https://www.rfc-editor.org/info/rfc4293</a>&gt;.
1692
1693 [<a id="ref-RFC7217">RFC7217</a>] Gont, F., "A Method for Generating Semantically Opaque
1694 Interface Identifiers with IPv6 Stateless Address
1695 Autoconfiguration (SLAAC)", <a href="./rfc7217">RFC 7217</a>,
1696 DOI 10.17487/RFC7217, April 2014,
1697 &lt;<a href="https://www.rfc-editor.org/info/rfc7217">https://www.rfc-editor.org/info/rfc7217</a>&gt;.
1698
1699 [<a id="ref-RFC8022">RFC8022</a>] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
1700 Management", <a href="./rfc8022">RFC 8022</a>, DOI 10.17487/RFC8022,
1701 November 2016, &lt;<a href="https://www.rfc-editor.org/info/rfc8022">https://www.rfc-editor.org/info/rfc8022</a>&gt;.
1702
1703 [<a id="ref-RFC8340">RFC8340</a>] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
1704 <a href="https://www.rfc-editor.org/bcp/bcp215">BCP 215</a>, <a href="./rfc8340">RFC 8340</a>, DOI 10.17487/RFC8340, March 2018,
1705 &lt;<a href="https://www.rfc-editor.org/info/rfc8340">https://www.rfc-editor.org/info/rfc8340</a>&gt;.
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732 <span class="grey">Bjorklund Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1735
1736
1737 <span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Example: NETCONF &lt;get-config&gt; Reply</span>
1738
1739 This section gives an example of a reply to the NETCONF &lt;get-config&gt;
1740 request for the running configuration datastore for a device that
1741 implements the data model defined in this document.
1742
1743 The XML [<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>] snippets that follow in this section
1744 and in <a href="#appendix-B">Appendix B</a> are provided as examples only.
1745
1746 &lt;rpc-reply
1747 xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
1748 message-id="101"&gt;
1749 &lt;data&gt;
1750 &lt;interfaces
1751 xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
1752 xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type"&gt;
1753 &lt;interface&gt;
1754 &lt;name&gt;eth0&lt;/name&gt;
1755 &lt;type&gt;ianaift:ethernetCsmacd&lt;/type&gt;
1756 &lt;ipv4 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip"&gt;
1757 &lt;address&gt;
1758 &lt;ip&gt;192.0.2.1&lt;/ip&gt;
1759 &lt;prefix-length&gt;24&lt;/prefix-length&gt;
1760 &lt;/address&gt;
1761 &lt;/ipv4&gt;
1762 &lt;ipv6 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip"&gt;
1763 &lt;mtu&gt;1280&lt;/mtu&gt;
1764 &lt;address&gt;
1765 &lt;ip&gt;2001:db8::10&lt;/ip&gt;
1766 &lt;prefix-length&gt;32&lt;/prefix-length&gt;
1767 &lt;/address&gt;
1768 &lt;dup-addr-detect-transmits&gt;0&lt;/dup-addr-detect-transmits&gt;
1769 &lt;/ipv6&gt;
1770 &lt;/interface&gt;
1771 &lt;/interfaces&gt;
1772 &lt;/data&gt;
1773 &lt;/rpc-reply&gt;
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788 <span class="grey">Bjorklund Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1791
1792
1793 <span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Example: NETCONF &lt;get-data&gt; Reply</span>
1794
1795 This section gives an example of a reply to the NETCONF &lt;get-data&gt;
1796 request for the operational state datastore for a device that
1797 implements the data model defined in this document.
1798
1799 This example uses the "origin" annotation, which is defined in the
1800 module "ietf-origin" [<a href="./rfc8342" title="&quot;Network Management Datastore Architecture (NMDA)&quot;">RFC8342</a>].
1801
1802 &lt;rpc-reply
1803 xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
1804 message-id="101"&gt;
1805 &lt;data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-datastores"&gt;
1806 &lt;interfaces
1807 xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
1808 xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type"
1809 xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin"&gt;
1810
1811 &lt;interface or:origin="or:intended"&gt;
1812 &lt;name&gt;eth0&lt;/name&gt;
1813 &lt;type&gt;ianaift:ethernetCsmacd&lt;/type&gt;
1814 &lt;!-- other parameters from ietf-interfaces omitted --&gt;
1815
1816 &lt;ipv4 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip"&gt;
1817 &lt;enabled or:origin="or:default"&gt;true&lt;/enabled&gt;
1818 &lt;forwarding or:origin="or:default"&gt;false&lt;/forwarding&gt;
1819 &lt;mtu or:origin="or:system"&gt;1500&lt;/mtu&gt;
1820 &lt;address&gt;
1821 &lt;ip&gt;192.0.2.1&lt;/ip&gt;
1822 &lt;prefix-length&gt;24&lt;/prefix-length&gt;
1823 &lt;origin&gt;static&lt;/origin&gt;
1824 &lt;/address&gt;
1825 &lt;neighbor or:origin="or:learned"&gt;
1826 &lt;ip&gt;192.0.2.2&lt;/ip&gt;
1827 &lt;link-layer-address&gt;
1828 00:00:5E:00:53:AB
1829 &lt;/link-layer-address&gt;
1830 &lt;/neighbor&gt;
1831 &lt;/ipv4&gt;
1832 &lt;ipv6 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip"&gt;
1833 &lt;enabled or:origin="or:default"&gt;true&lt;/enabled&gt;
1834 &lt;forwarding or:origin="or:default"&gt;false&lt;/forwarding&gt;
1835 &lt;mtu&gt;1280&lt;/mtu&gt;
1836
1837
1838
1839
1840
1841
1842
1843
1844 <span class="grey">Bjorklund Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc8344">RFC 8344</a> YANG IP Management March 2018</span>
1847
1848
1849 &lt;address&gt;
1850 &lt;ip&gt;2001:db8::10&lt;/ip&gt;
1851 &lt;prefix-length&gt;32&lt;/prefix-length&gt;
1852 &lt;origin&gt;static&lt;/origin&gt;
1853 &lt;status&gt;preferred&lt;/status&gt;
1854 &lt;/address&gt;
1855 &lt;address or:origin="or:learned"&gt;
1856 &lt;ip&gt;2001:db8::1:100&lt;/ip&gt;
1857 &lt;prefix-length&gt;32&lt;/prefix-length&gt;
1858 &lt;origin&gt;dhcp&lt;/origin&gt;
1859 &lt;status&gt;preferred&lt;/status&gt;
1860 &lt;/address&gt;
1861 &lt;dup-addr-detect-transmits&gt;0&lt;/dup-addr-detect-transmits&gt;
1862 &lt;neighbor or:origin="or:learned"&gt;
1863 &lt;ip&gt;2001:db8::1&lt;/ip&gt;
1864 &lt;link-layer-address&gt;
1865 00:00:5E:00:53:AB
1866 &lt;/link-layer-address&gt;
1867 &lt;origin&gt;dynamic&lt;/origin&gt;
1868 &lt;is-router/&gt;
1869 &lt;state&gt;reachable&lt;/state&gt;
1870 &lt;/neighbor&gt;
1871 &lt;neighbor or:origin="or:learned"&gt;
1872 &lt;ip&gt;2001:db8::4&lt;/ip&gt;
1873 &lt;origin&gt;dynamic&lt;/origin&gt;
1874 &lt;state&gt;incomplete&lt;/state&gt;
1875 &lt;/neighbor&gt;
1876 &lt;/ipv6&gt;
1877 &lt;/interface&gt;
1878 &lt;/interfaces&gt;
1879 &lt;/data&gt;
1880 &lt;/rpc-reply&gt;
1881
1882 Acknowledgments
1883
1884 The author wishes to thank Jeffrey Lange, Ladislav Lhotka, Juergen
1885 Schoenwaelder, and Dave Thaler for their helpful comments.
1886
1887 Author's Address
1888
1889 Martin Bjorklund
1890 Tail-f Systems
1891
1892 Email: [email protected]
1893
1894
1895
1896
1897
1898
1899
1900 Bjorklund Standards Track [Page 34]
1901 </pre>