1 module ietf-dhcpv6-common {
3 namespace "urn:ietf:params:xml:ns:yang:ietf-dhcpv6-common";
4 prefix "dhcpv6-common";
6 import ietf-yang-types {
9 "RFC 6991: Common YANG Data Types";
12 organization "DHC WG";
14 "yong@csnet1.cs.tsinghua.edu.cn
17 sladjana.zechlin@telekom.de
18 hezihao9512@gmail.com";
20 description "This YANG module defines common components
21 used for the configuration and management of DHCPv6.
23 Copyright (c) 2021 IETF Trust and the persons identified as
24 authors of the code. All rights reserved.
26 Redistribution and use in source and binary forms, with or
27 without modification, is permitted pursuant to, and subject
28 to the license terms contained in, the Simplified BSD License
29 set forth in Section 4.c of the IETF Trust's Legal Provisions
30 Relating to IETF Documents
31 (http://trustee.ietf.org/license-info).
33 This version of this YANG module is part of RFC 8513; see
34 the RFC itself for full legal notices.";
37 description "Version update for draft -17 publication.";
38 reference "I-D: draft-ietf-dhc-dhcpv6-yang-17";
42 description "Version update for draft -16 publication.";
43 reference "I-D: draft-ietf-dhc-dhcpv6-yang-16";
47 description "Version update for draft -13 publication.";
48 reference "I-D: draft-ietf-dhc-dhcpv6-yang-15";
52 description "Version update for draft -13 publication.";
53 reference "I-D: draft-ietf-dhc-dhcpv6-yang-13";
57 description "Version update for draft -12 publication.";
58 reference "I-D: draft-ietf-dhc-dhcpv6-yang-12";
62 description "Version update for draft -11 publication and
63 to align revisions across the different modules.";
64 reference "I-D: draft-ietf-dhc-dhcpv6-yang-11";
69 reference "I-D: draft-ietf-dhc-dhcpv6-yang";
73 description "Initial revision";
74 reference "I-D: draft-ietf-dhc-dhcpv6-yang";
84 description "No threshold";
88 description "Threshold value in percent";
91 typedef timer-seconds32 {
93 range "1..4294967295";
97 "Timer value type, in seconds (32-bit range).";
105 description "Each server and client has only one DUID (DHCP
106 Unique Identifier). The DUID here identifies a unique
107 DHCPv6 server for clients. DUID consists of a two-octet
108 type field and an arbitrary length (no more than 128 bytes)
109 content field. Currently there are four defined types of
110 DUIDs in RFC8415 and RFC6355 - DUID-LLT, DUID-EN, DUID-LL
111 and DUID-UUID. DUID-unstructured represents DUIDs which
112 do not follow any of the defined formats.";
113 reference "RFC8415: Section 11 and RFC6355: Section 4";
117 description "Type code of this DUID.";
120 default duid-unstructured;
121 description "Selects the format of the DUID.";
123 description "DUID Based on Link-layer Address Plus Time
124 (Type 1 - DUID-LLT).";
125 reference "RFC8415 Section 11.2";
126 leaf duid-llt-hardware-type {
128 description "Hardware type as assigned by IANA (RFC826).";
132 description "The time that the DUID is generated
133 represented in seconds since midnight (UTC),
134 January 1, 2000, modulo 2^32.";
136 leaf duid-llt-link-layer-address {
137 type yang:mac-address;
138 description "Link-layer address as described in RFC2464.";
142 description "DUID Assigned by Vendor Based on Enterprise
143 Number (Type 2 - DUID-EN).";
144 reference "RFC8415 Section 11.3";
145 leaf duid-en-enterprise-number {
147 description "Vendor's registered Private Enterprise Number
148 as maintained by IANA.";
150 leaf duid-en-identifier {
152 description "Identifier, unique to the device.";
156 description "DUID Based on Link-layer Address
157 (Type 3 - DUID-LL).";
158 reference "RFC8415 Section 11.4";
159 leaf duid-ll-hardware-type {
161 description "Hardware type, as assigned by IANA (RFC826).";
163 leaf duid-ll-link-layer-address {
164 type yang:mac-address;
165 description "Link-layer address, as described in RFC2464";
169 description "DUID Based on Universally Unique Identifier
170 (Type 4 - DUID-UUID).";
171 reference "RFC6335 Definition of the UUID-Based Unique
175 description "A Universally Unique Identifier in the string
176 representation, defined in RFC4122. The canonical
177 representation uses lowercase characters.";
180 case duid-unstructured {
181 description "DUID which does not follow any of the other
182 structures, expressed as bytes.";
185 description "The bits to be used as the identifier.";
192 description "The DUID which is currently in use.";
196 grouping auth-option-group {
197 description "OPTION_AUTH (11) Authentication Option.";
198 reference "RFC8415: Dynamic Host Configuration Protocol
200 container auth-option {
201 description "OPTION_AUTH (11) Authentication Option
205 description "The authentication protocol used in this
206 Authentication option.";
210 description "The algorithm used in the authentication
215 description "The replay detection method used
216 in this Authentication option.";
218 leaf replay-detection {
220 description "The replay detection information for the RDM.";
222 leaf auth-information {
224 description "The authentication information, as specified
225 by the protocol and algorithm used in this Authentication
230 grouping status-code-option-group {
231 description "OPTION_STATUS_CODE (13) Status Code Option.";
232 reference "RFC8415: Dynamic Host Configuration Protocol
234 container status-code-option {
235 description "OPTION_STATUS_CODE (13) Status Code Option
239 description "The numeric code for the status encoded
240 in this option. See the Status Codes registry at
241 <https://www.iana.org/assignments/dhcpv6-parameters>
242 for the current list of status codes.";
244 leaf status-message {
246 description "A UTF-8 encoded text string suitable for
247 display to an end user. MUST NOT be null-terminated.";
252 grouping rapid-commit-option-group {
253 description "OPTION_RAPID_COMMIT (14) Rapid Commit Option.";
254 reference "RFC8415: Dynamic Host Configuration Protocol for
256 container rapid-commit-option {
257 presence "Enable sending of this option";
258 description "OPTION_RAPID_COMMIT (14) Rapid Commit Option
263 grouping vendor-specific-information-option-group {
264 description "OPTION_VENDOR_OPTS (17) Vendor-specific
265 Information Option.";
266 reference "RFC8415: Dynamic Host Configuration Protocol
268 container vendor-specific-information-option {
269 description "OPTION_VENDOR_OPTS (17) Vendor-specific
270 Information Option container.";
271 list vendor-specific-information-option-instances {
272 key enterprise-number;
273 description "The vendor specific information option allows
274 for multiple instances in a single message. Each list entry
275 defines the contents of an instance of the option.";
276 leaf enterprise-number {
278 description "The vendor's registered Enterprise Number,
279 as maintained by IANA.";
281 list vendor-option-data {
283 description "Vendor options, interpreted by vendor-specific
284 client/server functions.";
285 leaf sub-option-code {
287 description "The code for the sub-option.";
289 leaf sub-option-data {
291 description "The data area for the sub-option.";
298 grouping reconfigure-accept-option-group {
299 description "OPTION_RECONF_ACCEPT (20) Reconfigure Accept
301 A client uses the Reconfigure Accept option to announce to
302 the server whether the client is willing to accept Reconfigure
303 messages, and a server uses this option to tell the client
304 whether or not to accept Reconfigure messages. In the absence
305 of this option, the default behavior is that the client is
306 unwilling to accept Reconfigure messages. The presence node
307 is used to enable the option.";
308 reference "RFC8415: Dynamic Host Configuration Protocol
310 container reconfigure-accept-option {
311 presence "Enable sending of this option";
312 description "OPTION_RECONF_ACCEPT (20) Reconfigure Accept