-
Notifications
You must be signed in to change notification settings - Fork 0
/
draft-ietf-netconf-udp-client-server-01.xml
404 lines (331 loc) · 13.6 KB
/
draft-ietf-netconf-udp-client-server-01.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="2"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" docName="draft-ietf-netconf-udp-client-server-01"
ipr="trust200902">
<front>
<title abbrev="udp-client-server-grouping">YANG Groupings for UDP
Clients and UDP Servers</title>
<author fullname="Alex Huang Feng" initials="A." surname="Huang Feng">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Pierre Francois" initials="P." surname="Francois">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Kent Watsen" initials="K." surname="Watsen">
<organization>Watsen Networks</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date day="27" month="February" year="2024"/>
<abstract>
<t>This document defines two YANG 1.1 modules to
support the configuration of UDP clients and UDP servers.</t>
</abstract>
<note title="Requirements Language">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP 14
<xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when,
they appear in all capitals, as shown here.</t>
</note>
</front>
<middle>
<section anchor="introduction" title="Introduction">
<t>This document defines two YANG 1.1 <xref target="RFC7950"/> modules to support
the configuration of UDP clients and UDP servers <xref target="RFC768"/>, either
as standalone or in conjunction with configuration of other layers.</t>
</section>
<section anchor="udp-client" title='The "ietf-udp-client" Module'>
<t>The "ietf-udp-client" YANG module defines the "udp-client-grouping"
grouping for configuring UDP clients with remote server information.</t>
<section anchor="udp-client-grouping" title='The "udp-client-grouping" Grouping'>
<t>The following tree diagram <xref target="RFC8340"/> illustrates the tree
structure of the "udp-client-grouping" grouping:</t>
<t><figure>
<artwork><![CDATA[
module: ietf-udp-client
grouping udp-client-grouping:
+-- remote-address inet:ip-address-no-zone
+-- remote-port? inet:port-number
]]></artwork>
</figure>
</t>
</section>
<section anchor="udp-client-ym" title="YANG Module">
<t>This module imports types defined in <xref target="RFC6991"/>.</t>
<t><figure>
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-udp-client {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-udp-client";
prefix udpc;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Alex Huang Feng
<mailto:[email protected]>
Pierre Francois
<mailto:[email protected]>";
description
"Defines a generic grouping for UDP-based client applications.
Copyright (c) 2024 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, is permitted pursuant to, and subject to the license
terms contained in, the Revised BSD License set forth in Section
4.c of the IETF Trust's Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC-to-be; see the RFC
itself for full legal notices.";
revision 2024-02-26 {
description
"Initial revision";
reference
"RFC-to-be: YANG Grouping for UDP Clients and UDP Servers";
}
grouping udp-client-grouping {
description
"Provides a reusable grouping for configuring a UDP client.";
leaf remote-address {
type inet:ip-address-no-zone;
mandatory true;
description
"Specifies an IP address of the UDP client, which can be an
IPv4 address or an IPv6 address.";
}
leaf remote-port {
type inet:port-number;
default "0";
description
"Specifies a port number of the UDP client. An invalid default
value is used so that importing modules may 'refine' it with
the appropriate default port number value.";
}
}
}
<CODE ENDS>]]></artwork>
</figure>
</t>
</section>
</section>
<section anchor="udp-server" title='The "ietf-udp-server" Module'>
<t>The "ietf-udp-server" YANG module defines the "udp-server-grouping" grouping for
configuring UDP servers.</t>
<section anchor="udp-server-grouping" title='The "udp-server-grouping" Grouping'>
<t>The following tree diagram <xref target="RFC8340"/> illustrates the structure of
"udp-server-grouping" grouping:</t>
<t><figure>
<artwork><![CDATA[
module: ietf-udp-server
grouping udp-server-grouping:
+-- local-address inet:ip-address-no-zone
+-- local-port? inet:port-number
]]></artwork>
</figure>
</t>
</section>
<section anchor="udp-server-ym" title="YANG Module">
<t>The "ietf-udp-server" imports types defined in <xref target="RFC6991"/>.</t>
<t><figure>
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-udp-server {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-udp-server";
prefix udps;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Alex Huang Feng
<mailto:[email protected]>
Pierre Francois
<mailto:[email protected]>";
description
"Defines a generic grouping for UDP-based server applications.
Copyright (c) 2024 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, is permitted pursuant to, and subject to the license
terms contained in, the Revised BSD License set forth in Section
4.c of the IETF Trust's Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC-to-be; see the RFC
itself for full legal notices.";
revision 2024-02-26 {
description
"Initial revision";
reference
"RFC-to-be: YANG Grouping for UDP Clients and UDP Servers";
}
grouping udp-server-grouping {
description
"Provides a reusable grouping for configuring a UDP servers.";
leaf local-address {
type inet:ip-address-no-zone;
mandatory true;
description
"Specifies an IP address of the UDP server, which can be an
IPv4 address or an IPv6 address.";
}
leaf local-port {
type inet:port-number;
default "0";
description
"Specifies a port number of the UDP server. An invalid default
value is used so that importing modules may 'refine' it with
the appropriate default port number value.";
}
}
}
<CODE ENDS>]]></artwork>
</figure>
</t>
</section>
</section>
<section anchor="security" title="Security Considerations">
<t>The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF <xref target="RFC6241"/> or RESTCONF <xref target="RFC8040"/>.
The lowest NETCONF layer is the secure transport layer, and the
mandatory-to-implement secure transport is Secure Shell (SSH) <xref target="RFC6242"/>.
The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport
is TLS <xref target="RFC8446"/>.
</t>
<t>The Network Configuration Access Control Model (NACM) <xref target="RFC8341"/> provides
the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured
subset of all available NETCONF or RESTCONF protocol operations and content.
</t>
<t>Since the module in this document only define groupings, these considerations are
primarily for the designers of other modules that use these groupings.</t>
<t>None of the readable data nodes defined in this YANG module are considered sensitive
or vulnerable in network environments. The NACM "default-deny-all" extension has not
been set for any data nodes defined in this module.</t>
<t>None of the writable data nodes defined in this YANG module are considered sensitive
or vulnerable in network environments. The NACM "default-deny-write" extension has not
been set for any data nodes defined in this module.</t>
<t>This module does not define any RPCs, actions, or notifications, and thus the security
consideration for such is not provided here.</t>
</section>
<section anchor="IANA_Considerations" title="IANA Considerations">
<t>This document describes the URIs from IETF
XML Registry and the registration of a two new YANG module names</t>
<section title="URI">
<t>IANA is requested to assign two new URI from the <xref
target="RFC3688">IETF XML Registry</xref>. The following two URIs are
suggested:</t>
<t><figure>
<artwork align="left"><![CDATA[
URI: urn:ietf:params:xml:ns:yang:ietf-udp-client
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.]]></artwork>
</figure></t>
<t><figure>
<artwork align="left"><![CDATA[
URI: urn:ietf:params:xml:ns:yang:ietf-udp-server
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.]]></artwork>
</figure></t>
</section>
<section title="YANG module name">
<t>This document also requests two new YANG module names in the
<xref target="RFC8342">YANG Module Names registry</xref> with the
following suggestions:</t>
<t><figure>
<artwork align="left"><![CDATA[
name: ietf-udp-client
namespace: urn:ietf:params:xml:ns:yang:ietf-udp-client
prefix: udpc
maintained by IANA? N
reference: RFC-to-be]]></artwork>
</figure></t>
<t><figure>
<artwork align="left"><![CDATA[
name: ietf-udp-server
namespace: urn:ietf:params:xml:ns:yang:ietf-udp-server
prefix: udps
maintained by IANA? N
reference: RFC-to-be]]></artwork>
</figure></t>
</section>
</section>
<section anchor="acknowledgements" title="Acknowledgements">
<t>The authors would like to thank Mohamed Boucadair, Benoit Claise, Qiufang Ma
and Qin Wu for their review and valuable comments.</t>
</section>
</middle>
<back>
<references title="Normative References">
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.768.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.3688.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6241.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6242.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6991.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.7950.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8341.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8174.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8040.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8340.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8342.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8446.xml"?>
</references>
<references title="Informative References">
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.9325.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.8085.xml"?>
<?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.9147.xml"?>
<?rfc include="https://bib.ietf.org/public/rfc/bibxml-ids/reference.I-D.ietf-netconf-tls-client-server.xml"?>
</references>
</back>
</rfc>