-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathietf-netconf-client.yang
555 lines (519 loc) · 19.7 KB
/
ietf-netconf-client.yang
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
module ietf-netconf-client {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client";
prefix ncc;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-tcp-client {
prefix tcpc;
reference
"RFC DDDD: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-tcp-server {
prefix tcps;
reference
"RFC DDDD: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-ssh-client {
prefix sshc;
reference
"RFC EEEE: YANG Groupings for SSH Clients and SSH Servers";
}
import ietf-tls-client {
prefix tlsc;
reference
"RFC FFFF: YANG Groupings for TLS Clients and TLS Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netconf
WG List: NETCONF WG list <mailto:[email protected]>
Author: Kent Watsen <mailto:[email protected]>";
description
"This module contains a collection of YANG definitions
for configuring NETCONF clients.
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 HHHH
(https://www.rfc-editor.org/info/rfcHHHH); see the RFC
itself for full legal notices.
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 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision YYYY-MM-DD {
description
"Initial version";
reference
"RFC HHHH: NETCONF Client and Server Models";
}
// Features
feature ssh-initiate {
description
"The 'ssh-initiate' feature indicates that the NETCONF client
supports initiating SSH connections to NETCONF servers.";
reference
"RFC 6242:
Using the NETCONF Protocol over Secure Shell (SSH)";
}
feature tls-initiate {
description
"The 'tls-initiate' feature indicates that the NETCONF client
supports initiating TLS connections to NETCONF servers.";
reference
"RFC 7589: Using the NETCONF Protocol over Transport
Layer Security (TLS) with Mutual X.509 Authentication";
}
feature ssh-listen {
description
"The 'ssh-listen' feature indicates that the NETCONF client
supports opening a port to listen for incoming NETCONF
server call-home SSH connections.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
feature tls-listen {
description
"The 'tls-listen' feature indicates that the NETCONF client
supports opening a port to listen for incoming NETCONF
server call-home TLS connections.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
feature central-netconf-client-supported {
description
"The 'central-netconf-client-supported' feature indicates
that the server that implements this module supports
the top-level 'netconf-client' node.
This feature is needed as some servers may want to use
features defined in this module, which requires this
module to be implemented, without having to support
the top-level 'netconf-client' node.";
}
// Groupings
grouping netconf-client-grouping {
description
"A reusable grouping for configuring a NETCONF client
without any consideration for how underlying transport
sessions are established.
This grouping currently does not define any nodes. It
exists only so the model can be consistent with other
'client-server' models.";
}
grouping netconf-client-initiate-stack-grouping {
description
"A reusable grouping for configuring a NETCONF client
'initiate' protocol stack for a single outbound connection.";
choice transport {
mandatory true;
description
"Selects between available transports.";
case ssh {
if-feature "ssh-initiate";
container ssh {
description
"Specifies TCP, SSH, and NETCONF configuration
for the connection.";
container tcp-client-parameters {
description
"TCP-level client parameters to initiate
a NETCONF over SSH connection.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default "830";
description
"The NETCONF client will attempt to connect
to the IANA-assigned well-known port value
for 'netconf-ssh' (830) if no value is
specified.";
}
}
}
container ssh-client-parameters {
description
"SSH-level client parameters to initiate
a NETCONF over SSH connection.";
uses sshc:ssh-client-grouping;
}
container netconf-client-parameters {
description
"NETCONF-level client parameters to initiate
a NETCONF over SSH connection.";
uses ncc:netconf-client-grouping;
}
}
}
case tls {
if-feature "tls-initiate";
container tls {
description
"Specifies TCP, TLS, and NETCONF configuration
for the connection.";
container tcp-client-parameters {
description
"TCP-level client parameters to initiate
a NETCONF over TLS connection.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default "6513";
description
"The NETCONF client will attempt to connect
to the IANA-assigned well-known port value
for 'netconf-tls' (6513) if no value is
specified.";
}
}
}
container tls-client-parameters {
must client-identity {
description
"NETCONF/TLS clients MUST pass some
authentication credentials.";
}
description
"TLS-level client parameters to initiate
a NETCONF over TLS connection.";
uses tlsc:tls-client-grouping;
}
container netconf-client-parameters {
description
"NETCONF-level client parameters to initiate
a NETCONF over TLS connection.";
uses ncc:netconf-client-grouping;
}
}
}
}
} // netconf-client-initiate-stack-grouping
grouping netconf-client-listen-stack-grouping {
description
"A reusable grouping for configuring a NETCONF client
'listen' protocol stack for listening on a single port. The
'listen' stack supports call home connections, as
described in RFC 8071";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
choice transport {
mandatory true;
description
"Selects between available transports.";
case ssh {
if-feature "ssh-listen";
container ssh {
description
"TCP, SSH, and NETCONF configuration to listen
for NETCONF over SSH Call Home connections.";
container tcp-server-parameters {
description
"TCP-level server parameters to listen for
NETCONF over SSH Call Home connections.";
uses tcps:tcp-server-grouping {
refine "local-bind/local-port" {
default "4334";
description
"The NETCONF client will listen on the IANA-
assigned well-known port for 'netconf-ch-ssh'
(4334) if no value is specified.";
}
}
}
container ssh-client-parameters {
description
"SSH-level client parameters to listen for
NETCONF over SSH Call Home connections.";
uses sshc:ssh-client-grouping;
}
container netconf-client-parameters {
description
"NETCONF-level client parameters to listen for
NETCONF over SSH Call Home connections.";
uses ncc:netconf-client-grouping;
}
}
}
case tls {
if-feature "tls-listen";
container tls {
description
"TCP, TLS, and NETCONF configuration to listen
for NETCONF over TLS Call Home connections.";
container tcp-server-parameters {
description
"TCP-level server parameters to listen for
NETCONF over TLS Call Home connections.";
uses tcps:tcp-server-grouping {
refine "local-bind/local-port" {
default "4335";
description
"The NETCONF client will listen on the IANA-
assigned well-known port for 'netconf-ch-tls'
(4335) if no value is specified.";
}
}
}
container tls-client-parameters {
must client-identity {
description
"NETCONF/TLS clients MUST pass some
authentication credentials.";
}
description
"TLS-level client parameters to listen for
NETCONF over TLS Call Home connections.";
uses tlsc:tls-client-grouping;
}
container netconf-client-parameters {
description
"NETCONF-level client parameters to listen for
NETCONF over TLS Call Home connections.";
uses ncc:netconf-client-grouping;
}
}
}
}
} // netconf-client-listen-stack-grouping
grouping netconf-client-app-grouping {
description
"A reusable grouping for configuring a NETCONF client
application that supports both 'initiate' and 'listen'
protocol stacks for a multiplicity of connections.";
container initiate {
if-feature "ssh-initiate or tls-initiate";
presence
"Indicates that client-initiated connections have been
configured. This statement is present so the mandatory
descendant nodes do not imply that this node must be
configured.";
description
"Configures client initiating underlying TCP connections.";
list netconf-server {
key "name";
min-elements 1;
description
"List of NETCONF servers the NETCONF client is to
maintain simultaneous connections with.";
leaf name {
type string;
description
"An arbitrary name for the NETCONF server.";
}
container endpoints {
description
"Container for the list of endpoints.";
list endpoint {
key "name";
min-elements 1;
ordered-by user;
description
"A user-ordered list of endpoints that the NETCONF
client will attempt to connect to in the specified
sequence. Defining more than one enables
high-availability.";
leaf name {
type string;
description
"An arbitrary name for the endpoint.";
}
uses netconf-client-initiate-stack-grouping;
} // list endpoint
} // container endpoints
container connection-type {
description
"Indicates the NETCONF client's preference for how the
NETCONF connection is maintained.";
choice connection-type {
mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
description
"Maintain a persistent connection to the NETCONF
server. If the connection goes down, immediately
start trying to reconnect to the NETCONF server,
using the reconnection strategy.
This connection type minimizes any NETCONF server
to NETCONF client data-transfer delay, albeit at
the expense of holding resources longer.";
}
}
case periodic-connection {
container periodic {
presence "Indicates that a periodic connection is
to be maintained.";
description
"Periodically connect to the NETCONF server.
This connection type decreases resource
utilization, albeit with increased delay in
NETCONF server to NETCONF client interactions.
The NETCONF client should close the underlying
TCP connection upon completing planned activities.
Connections are established at the same start
time regardless how long the previous connection
stayed open.
In the case that the previous connection is still
active, establishing a new connection is NOT
RECOMMENDED.";
leaf period {
type uint16;
units "minutes";
default "60";
description
"Duration of time between periodic connections.";
}
leaf anchor-time {
type yang:date-and-time {
// constrained to minute-level granularity
pattern '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2]'
+ '[0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-3]):['
+ '0-5][0-9]:00(Z|[\+\-]((1[0-3]|0[0-9]):'
+ '([0-5][0-9])|14:00))?';
}
description
"Designates a timestamp before or after which a
series of periodic connections are determined.
The periodic connections occur at a whole
multiple interval from the anchor time.
If an 'anchor-time' is not provided, then the
server may implicitly set it to the time when
this configuraton is applied (e.g., on boot).
For example, for an anchor time is 15 minutes
past midnight and a period interval of 24 hours,
then a periodic connection will occur 15 minutes
past midnight everyday.";
}
leaf idle-timeout {
type uint16;
units "seconds";
default 180; // three minutes
description
"Specifies the maximum number of seconds that
a NETCONF session may remain idle. A NETCONF
session will be dropped if it is idle for an
interval longer then this number of seconds.
If set to zero, then the NETCONF client will
never drop a session because it is idle.";
}
}
}
}
}
container reconnect-strategy {
description
"The reconnection strategy directs how a NETCONF client
reconnects to a NETCONF server, after discovering its
connection to the server has dropped, even if due to a
reboot. The NETCONF client starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start with
the first endpoint listed.";
}
enum last-connected {
description
"Indicates that reconnections should start with
the endpoint last connected to, if known. If
no previous connection is known, then the
first endpoint configured is used.";
}
enum random-selection {
description
"Indicates that reconnections should start with
a random endpoint.";
}
}
default "first-listed";
description
"Specifies which of the NETCONF server's endpoints
the NETCONF client should start with when trying
to connect to the NETCONF server.";
}
leaf max-wait {
type uint16 {
range "1..max";
}
units "seconds";
default "5";
description
"Specifies the amount of time in seconds after which,
if the connection is not established, an endpoint
connection attempt is considered unsuccessful.";
}
leaf max-attempts {
type uint8 {
range "1..max";
}
default "3";
description
"Specifies the number times the NETCONF client tries
to connect to a specific endpoint before moving on
to the next endpoint in the list (round robin).";
}
}
} // netconf-server
} // initiate
container listen {
if-feature "ssh-listen or tls-listen";
presence
"Indicates that client-listening ports have been configured.
This statement is present so the mandatory descendant nodes
do not imply that this node must be configured.";
description
"Configures the client to accept call-home TCP connections.";
leaf idle-timeout {
type uint16;
units "seconds";
default "180"; // three minutes
description
"Specifies the maximum number of seconds that a NETCONF
session may remain idle. A NETCONF session will be
dropped if it is idle for an interval longer than this
number of seconds. If set to zero, then the server
will never drop a session because it is idle.";
}
container endpoints {
description
"Container for a list of endpoints.";
list endpoint {
key "name";
min-elements 1;
description
"List of endpoints to listen for NETCONF connections.";
leaf name {
type string;
description
"An arbitrary name for the NETCONF listen endpoint.";
}
uses netconf-client-listen-stack-grouping;
}
}
} // listen
} // netconf-client-app-grouping
// Protocol accessible node for clients that implement this module.
container netconf-client {
if-feature central-netconf-client-supported;
uses netconf-client-app-grouping;
description
"Top-level container for NETCONF client configuration.";
}
}