-
Notifications
You must be signed in to change notification settings - Fork 660
/
Copy pathopenconfig-system.yang
1370 lines (1128 loc) · 33.7 KB
/
openconfig-system.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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module openconfig-system {
yang-version "1";
// namespace
namespace "http://openconfig.net/yang/system";
prefix "oc-sys";
// import some basic types
import openconfig-inet-types { prefix oc-inet; }
import openconfig-yang-types { prefix oc-yang; }
import openconfig-types { prefix oc-types; }
import openconfig-extensions { prefix oc-ext; }
import openconfig-aaa { prefix oc-aaa; }
import openconfig-system-logging { prefix oc-log; }
import openconfig-system-terminal { prefix oc-sys-term; }
import openconfig-procmon { prefix oc-proc; }
import openconfig-platform { prefix oc-platform; }
import openconfig-alarms { prefix oc-alarms; }
import openconfig-messages { prefix oc-messages; }
import openconfig-license { prefix oc-license; }
import openconfig-network-instance { prefix oc-ni; }
// meta
organization "OpenConfig working group";
contact
"OpenConfig working group
netopenconfig@googlegroups.com";
description
"Model for managing system-wide services and functions on
network devices.
Portions of this code were derived from IETF RFC 7317.
Please reproduce this note if possible.
IETF code is subject to the following copyright and license:
Copyright (c) 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 Simplified BSD License set forth in
Section 4.c of the IETF Trust's Legal Provisions Relating
to IETF Documents (http://trustee.ietf.org/license-info).";
oc-ext:openconfig-version "2.3.0";
revision "2024-09-24" {
description
"Added mount-point type leaf to describe the type of file system.";
reference "2.3.0";
}
revision "2024-08-13" {
description
"Added additional auth key types";
reference "2.2.0";
}
revision "2024-07-15" {
description
"Added auth key reference in ntp server configuration.";
reference "2.1.0";
}
revision "2023-12-20" {
description
"Change NTP offset, root-delay, and root-dispersion to int64 nanoseconds,
and update their descriptions for accuracy and clarity.";
reference "2.0.0";
}
revision "2023-10-26" {
description
"Add up-time leaf and promote module to version 1.0.";
reference "1.0.0";
}
revision "2023-06-16" {
description
"Reordered imports to be alphabetical.";
reference "0.17.1";
}
revision "2022-12-20" {
description
"Added network instance leaf to ntp client, and dropped
ntp-source-address from global to individual config. Removed ntp prefix.";
reference "0.17.0";
}
revision "2022-12-19" {
description
"Update last configuration timestamp documentation.";
reference "0.16.1";
}
revision "2022-09-28" {
description
"Add last configuration timestamp leaf.";
reference "0.16.0";
}
revision "2022-07-25" {
description
"Add system software version.";
reference "0.15.0";
}
revision "2022-07-20" {
description
"Added routing-mac system MAC address.";
reference "0.14.0";
}
revision "2022-07-12" {
description
"Modify ntp enabled description to reflect true and false case.";
reference "0.13.1";
}
revision "2021-07-20" {
description
"Adding list of mount points.";
reference "0.13.0";
}
revision "2021-07-14" {
description
"Support for additional RAM usage counters.";
reference "0.12.0";
}
revision "2021-06-28" {
description
"Adding system memory error counters.";
reference "0.11.1";
}
revision "2021-06-16" {
description
"Remove trailing whitespace";
reference "0.10.1";
}
revision "2020-04-13" {
description
"Remove the existing grpc-service, and add a new list
of the gRPC servers in a new module.";
reference "0.10.0";
}
revision "2020-03-25" {
description
"Fix typo in description statement for ipv4-address
list.";
reference "0.9.1";
}
revision "2020-01-07" {
description
"Add import of license management model.";
reference "0.9.0";
}
revision "2019-03-15" {
description
"Update boot time to be nanoseconds since epoch.";
reference "0.8.0";
}
revision "2019-01-29" {
description
"Add messages module to the system model";
reference "0.7.0";
}
revision "2018-11-21" {
description
"Add OpenConfig module metadata extensions.";
reference "0.6.1";
}
revision "2018-07-17" {
description
"Add gRPC server data";
reference "0.6.0";
}
revision "2018-01-21" {
description
"Add cpu utilization data";
reference "0.5.0";
}
revision "2017-12-15" {
description
"Add alarms to the system model";
reference "0.4.0";
}
revision "2017-09-18" {
description
"Updated to use OpenConfig types modules";
reference "0.3.0";
}
revision "2017-07-06" {
description
"Move to oc-inet types, add IETF attribution, add RADIUS
counters, changed password leaf names to indicate hashed";
reference "0.2.0";
}
revision "2017-01-29" {
description
"Initial public release";
reference "0.1.0";
}
// OpenConfig specific extensions for module metadata.
oc-ext:regexp-posix;
oc-ext:catalog-organization "openconfig";
oc-ext:origin "openconfig";
// extension statements
// feature statements
// identity statements
identity NTP_AUTH_TYPE {
description
"Base identity for encryption schemes supported for NTP
authentication keys";
}
identity NTP_AUTH_MD5 {
base NTP_AUTH_TYPE;
description
"MD5 encryption method";
}
identity NTP_AUTH_SHA1 {
base NTP_AUTH_TYPE;
description
"SHA1 encryption method";
}
identity NTP_AUTH_SHA256 {
base NTP_AUTH_TYPE;
description
"SHA256 encryption method";
}
identity NTP_AUTH_SHA384 {
base NTP_AUTH_TYPE;
description
"SHA384 encryption method";
}
identity NTP_AUTH_SHA512 {
base NTP_AUTH_TYPE;
description
"SHA512 encryption method";
}
identity NTP_AUTH_AES_CBC_128 {
base NTP_AUTH_TYPE;
description
"AES-CBC-128 encryption method";
}
identity NTP_AUTH_AES_CBC_256 {
base NTP_AUTH_TYPE;
description
"AES-CBC-256 encryption method";
}
// typedef statements
typedef timezone-name-type {
type string;
description
"A time zone name as used by the Time Zone Database,
sometimes referred to as the 'Olson Database'.
The exact set of valid values is an implementation-specific
matter. Client discovery of the exact set of time zone names
for a particular server is out of scope.";
reference
"BCP 175: Procedures for Maintaining the Time Zone Database";
}
// grouping statements
grouping system-clock-config {
description
"Configuration data for system-wide clock configuration";
leaf timezone-name {
type timezone-name-type;
description
"The TZ database name to use for the system, such
as 'Europe/Stockholm'.";
reference "IANA Time Zone Database
http://www.iana.org/time-zones";
}
}
grouping system-clock-state {
description
"Operational state data for system-wide clock configuration";
}
grouping system-clock-top {
description
"Top-level grouping for system-wide clock configuration";
container clock {
description
"Top-level container for clock configuration data";
container config {
description
"Configuration data for system clock";
uses system-clock-config;
}
container state {
config false;
description
"Operational state data for system clock";
uses system-clock-config;
uses system-clock-state;
}
}
}
grouping system-global-config {
description "system-wide configuration parameters";
leaf hostname {
type oc-inet:domain-name;
description
"The hostname of the device -- should be a single domain
label, without the domain.";
}
leaf domain-name {
type oc-inet:domain-name;
description
"Specifies the domain name used to form fully qualified name
for unqualified hostnames.";
}
leaf login-banner {
type string;
description
"The console login message displayed before the login prompt,
i.e., before a user logs into the system.";
}
leaf motd-banner {
type string;
description
"The console message displayed after a user logs into the
system. They system may append additional standard
information such as the current system date and time, uptime,
last login timestamp, etc.";
}
}
grouping mount-point-state {
description
"Operational state data for the mount point.";
leaf name {
type string;
description
"Mount point name.";
}
leaf storage-component {
type leafref {
path "/oc-platform:components/oc-platform:component/" +
"oc-platform:name";
}
description
"In the case that the filesystem that is mounted corresponds to a
physical or logical component within the system, this leaf provides
a reference to the hosting component within the /components
hierarchy.
The reference should be to the most specific component (e.g., if an
entry for /dev/sda1 exists, then this should be referred to,
otherwise a reference to /dev/sda may be provided.";
}
leaf size {
type uint64;
units megabytes;
description
"The total size of the initialised filesystem.";
}
leaf available {
type uint64;
units megabytes;
description
"The amount of unused space on the filesystem.";
}
leaf utilized {
type uint64;
units megabytes;
description
"The amount of space currently in use on the filesystem.";
}
leaf type {
type string;
description
"A human readable string indicating the filesystem type used
for storage. Examples might include flash, hard disk, tmpfs/ramdisk
or remote/network based storage.";
}
}
grouping system-global-state {
description
"Global operational state data for the system";
leaf current-datetime {
type oc-yang:date-and-time;
description
"The current system date and time.";
}
leaf up-time {
type oc-types:timeticks64;
units "nanoseconds";
description
"The amount of time since the network operating system was
initialized.";
}
leaf boot-time {
type oc-types:timeticks64;
units "nanoseconds";
description
"This timestamp indicates the time that the system was last
restarted. The value is the timestamp in nanoseconds relative
to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).";
}
leaf software-version {
type string;
description
"Operating system version of the currently active controller
of the device. It is required that this value matches the
value of the state/software-version leaf in the component
of type OPERATING_SYSTEM.";
}
leaf last-configuration-timestamp {
type oc-types:timeticks64;
units "nanoseconds";
description
"Indicates the monotonically increasing timestamp at which the
last configuration change was made. This may may be through CLI,
gNMI or some other mechanism. The value is the timestamp in
nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).";
}
}
grouping mount-points-top {
description
"Top-level grouping for mount points data.";
container mount-points {
config false;
description
"When a system has a set of filesystems that are attached to a
directory (i.e., mounted on the system) they are expected to be
present in this list. If the system has the concept of mounting
physical or virtual resources to a mount point within the root
filesystem (/) they should also be included in this list.";
list mount-point {
key "name";
description
"List of mount points in the system.";
leaf name {
type leafref {
path "../state/name";
}
description
"Reference to the key for list of mount points.";
}
container state {
config false;
description
"State of system mount point.";
uses mount-point-state;
}
}
}
}
grouping system-dns-config {
description "DNS / resolver related configuration data";
leaf-list search {
type oc-inet:domain-name;
ordered-by user;
description
"An ordered list of domains to search when resolving
a host name.";
}
}
grouping system-dns-state {
description
"Operational state data for system DNS resolver";
}
grouping system-dns-servers-config {
description
"Configuration data for DNS resolvers";
//RFC 7317 includes a single-value choice statement to for
//TCP and UDP transport. This has been removed since it the
//transport protocol is not generally available as an options
//on target devices. It may be added back if and when needed.
leaf address {
type oc-inet:ip-address;
description
"The address of the DNS server, can be either IPv4
or IPv6.";
}
leaf port {
type oc-inet:port-number;
default 53;
description
"The port number of the DNS server.";
}
//RFC 7317 includes resolver timeout and attempts options. These
//have been omitted as they are not available on many targets. If
//and when they are required, they may be added back in.
}
grouping system-dns-static-config {
description
"Configuration data for static host entries";
leaf hostname {
type string;
description
"Hostname for the static DNS entry";
}
leaf-list alias {
type string;
description
"Additional aliases for the hostname";
}
leaf-list ipv4-address {
type oc-inet:ipv4-address;
description
"List of IPv4 addresses for the host entry";
}
leaf-list ipv6-address {
type oc-inet:ipv6-address;
description
"List of IPv6 addresses for the host entry";
}
}
grouping system-dns-static-state {
description
"Operational state data for static host entries";
}
grouping system-dns-static-top {
description
"Top-level grouping for static DNS host entries";
container host-entries {
description
"Enclosing container for list of static host entries";
list host-entry {
key "hostname";
description
"List of static host entries";
leaf hostname {
type leafref {
path "../config/hostname";
}
description
"Reference to the hostname list key";
}
container config {
description
"Configuration data for static host entries";
uses system-dns-static-config;
}
container state {
config false;
description
"Operational state data for static host entries";
uses system-dns-static-config;
uses system-dns-static-state;
}
}
}
}
grouping system-dns-servers-state {
description
"Operational state data for DNS resolvers";
}
grouping system-dns-servers-top {
description
"Top-level grouping for the list of DNS resolvers.";
container servers {
description
"Enclosing container for DNS resolver list";
list server {
key "address";
ordered-by user;
description
"List of the DNS servers that the resolver should query.
When the resolver is invoked by a calling application, it
sends the query to the first name server in this list. If
no response has been received within 'timeout' seconds,
the resolver continues with the next server in the list.
If no response is received from any server, the resolver
continues with the first server again. When the resolver
has traversed the list 'attempts' times without receiving
any response, it gives up and returns an error to the
calling application.
Implementations MAY limit the number of entries in this
list.";
leaf address {
type leafref {
path "../config/address";
}
description
"References the configured address of the DNS server";
}
container config {
description
"Configuration data for each DNS resolver";
uses system-dns-servers-config;
}
container state {
config false;
description
"Operational state data for each DNS resolver";
uses system-dns-servers-config;
uses system-dns-servers-state;
}
}
}
}
grouping system-dns-top {
description
"Top-level grouping for DNS / resolver config and operational
state data";
container dns {
description
"Enclosing container for DNS resolver data";
container config {
description
"Configuration data for the DNS resolver";
uses system-dns-config;
}
container state {
config false;
description
"Operational state data for the DNS resolver";
uses system-dns-config;
uses system-dns-state;
}
uses system-dns-servers-top;
uses system-dns-static-top;
}
}
grouping system-ntp-server-config {
description
"Configuration data for NTP servers";
leaf address {
type oc-inet:host;
description
"The address or hostname of the NTP server.";
}
leaf port {
type oc-inet:port-number;
default 123;
description
"The port number of the NTP server.";
}
leaf version {
type uint8 {
range 1..4;
}
default 4;
description
"Version number to put in outgoing NTP packets";
}
leaf association-type {
type enumeration {
enum SERVER {
description
"Use client association mode. This device
will not provide synchronization to the
configured NTP server.";
}
enum PEER {
description
"Use symmetric active association mode.
This device may provide synchronization
to the configured NTP server.";
}
enum POOL {
description
"Use client association mode with one or
more of the NTP servers found by DNS
resolution of the domain name given by
the 'address' leaf. This device will not
provide synchronization to the servers.";
}
}
default SERVER;
description
"The desired association type for this NTP server.";
}
leaf iburst {
type boolean;
default false;
description
"Indicates whether this server should enable burst
synchronization or not.";
}
leaf prefer {
type boolean;
default false;
description
"Indicates whether this server should be preferred
or not.";
}
leaf network-instance {
type oc-ni:network-instance-ref;
description
"The network instance used to find this server.";
}
leaf source-address {
type oc-inet:ip-address;
description
"Source address to use on outgoing NTP packets";
}
leaf key-id {
type leafref {
path "../../../../ntp-keys/ntp-key/key-id";
}
description
"Reference to NTP authentication key for this server.";
}
}
grouping system-ntp-server-state {
description
"Operational state data for NTP servers";
leaf stratum {
type uint8;
description
"Indicates the level of the server in the NTP hierarchy. As
stratum number increases, the accuracy is degraded. Primary
servers are stratum while a maximum value of 16 indicates
unsynchronized. The values have the following specific
semantics:
| 0 | unspecified or invalid
| 1 | primary server (e.g., equipped with a GPS receiver)
| 2-15 | secondary server (via NTP)
| 16 | unsynchronized
| 17-255 | reserved";
reference
"RFC 5905 - Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf root-delay {
type int64;
units "nanoseconds";
description
"The total round-trip delay to the reference clock, in nanoseconds.";
reference
"RFC 5905 - Network Time Protocol Version 4: Protocol and
Algorithms Specification, Section 7.3";
}
leaf root-dispersion {
type int64;
units "nanoseconds";
description
"The maximum error inherent in the measurement, accumulated over the
stratum levels from the reference clock.";
reference
"RFC 5905 - Network Time Protocol Version 4: Protocol and
Algorithms Specification, Section 4";
}
leaf offset {
type int64;
units "nanoseconds";
description
"Estimate of the current time offset from the peer. This is
the time difference of the peer's clock minus the local clock.";
reference
"RFC 5905 - Network Time Protocol Version 4: Protocol and
Algorithms Specification, Section 8";
}
leaf poll-interval {
type uint32;
units "seconds";
description
"Polling interval of the peer";
}
}
grouping system-ntp-server-top {
description
"Top-level grouping for the list of NTP servers";
container servers {
description
"Enclosing container for the list of NTP servers";
list server {
key "address";
description
"List of NTP servers to use for system clock
synchronization. If '/system/ntp/enabled'
is 'true', then the system will attempt to
contact and utilize the specified NTP servers.";
leaf address {
type leafref {
path "../config/address";
}
description
"References the configured address or hostname of the
NTP server.";
}
container config {
description
"Configuration data for an NTP server.";
uses system-ntp-server-config;
}
container state {
config false;
description
"Operational state data for an NTP server.";
uses system-ntp-server-config;
uses system-ntp-server-state;
}
}
}
}
grouping system-ntp-auth-keys-config {
description
"Configuration data ";
leaf key-id {
type uint16;
description
"Integer identifier used by the client and server to
designate a secret key. The client and server must use
the same key id.";
}
leaf key-type {
type identityref {
base NTP_AUTH_TYPE;
}
description
"Encryption type used for the NTP authentication key";
}
leaf key-value {
type string;
description
"NTP authentication key value";
}
}
grouping system-ntp-auth-keys-state {
description
"Operational state data for NTP auth key data";
}
grouping system-ntp-auth-keys-top {
description
"Top-level grouping for NTP auth key data";
container ntp-keys {
description
"Enclosing container for list of NTP authentication keys";
list ntp-key {
key "key-id";
description
"List of NTP authentication keys";
leaf key-id {
type leafref {
path "../config/key-id";
}
description
"Reference to auth key-id list key";
}
container config {
description
"Configuration data for NTP auth keys";
uses system-ntp-auth-keys-config;
}
container state {
config false;
description
"Operational state data for NTP auth keys";
uses system-ntp-auth-keys-config;
uses system-ntp-auth-keys-state;
}
}