-
Notifications
You must be signed in to change notification settings - Fork 0
/
draft-ietf-pce-pcep-yang-07.xml
4977 lines (4620 loc) · 177 KB
/
draft-ietf-pce-pcep-yang-07.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
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
<?xml version="1.0" encoding="us-ascii"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd"[]>
<?rfc toc="yes" ?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="4"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="no"?>
<?rfc rfcedstyle="yes"?>
<?rfc subcompact="no"?>
<?rfc compact="yes" ?>
<?rfc iprnotified="Yes" ?>
<?rfc strict="no" ?>
<rfc ipr="trust200902" category="std" docName="draft-ietf-pce-pcep-yang-07" obsoletes="" updates="" submissionType="IETF" xml:lang="en">
<front>
<title abbrev="PCE-YANG">A YANG Data Model for Path Computation Element Communications Protocol (PCEP)</title>
<author initials="D" surname="Dhody" fullname="Dhruv Dhody" role="editor">
<organization>Huawei Technologies</organization>
<address>
<postal>
<street>Divyashree Techno Park, Whitefield</street>
<city>Bangalore</city>
<region>Karnataka</region>
<code>560066</code>
<country>India</country>
</postal>
<email>dhruv.ietf@gmail.com</email>
</address>
</author>
<author fullname="Jonathan Hardwick" initials="J." surname="Hardwick">
<organization>Metaswitch</organization>
<address>
<postal>
<street>100 Church Street</street>
<city>Enfield</city>
<code>EN2 6BQ</code>
<country>UK</country>
</postal>
<email> jonathan.hardwick@metaswitch.com </email>
</address>
</author>
<author fullname="Vishnu Pavan Beeram" initials="V." surname="Beeram">
<organization>Juniper Networks</organization>
<address>
<postal>
<street></street>
<city></city>
<code></code>
<country>USA</country>
</postal>
<email> vbeeram@juniper.net </email>
</address>
</author>
<author fullname="Jeff Tantsura" initials="J." surname="Tantsura">
<organization></organization>
<address>
<postal>
<street></street>
<city></city>
<region></region>
<code></code>
<country>USA</country>
</postal>
<email>jefftant@gmail.com</email>
</address>
</author>
<date year="2018" />
<area>Routing</area>
<workgroup>PCE Working Group</workgroup>
<abstract>
<t>This document defines a YANG data model for the management of
Path Computation Element communications Protocol (PCEP) for
communications between a Path Computation Client (PCC) and a Path
Computation Element (PCE), or between two PCEs. The data model
includes configuration data and state data (status information and
counters for the collection of statistics).</t>
</abstract>
</front>
<middle>
<section title="Introduction" toc="default">
<t>The Path Computation Element (PCE) defined in <xref target="RFC4655"/>
is an entity that is capable of computing a network path or route
based on a network graph, and applying computational constraints.
A Path Computation Client (PCC) may make requests to a PCE for paths
to be computed.</t>
<t>PCEP is the communication protocol between a PCC and PCE and is
defined in <xref target="RFC5440"/>. PCEP interactions include path
computation requests and path computation replies as well as
notifications of specific states related to the use of a PCE in the
context of Multiprotocol Label Switching (MPLS) and Generalized MPLS
(GMPLS) Traffic Engineering (TE). <xref target='RFC8231'/>
specifies extensions to PCEP to enable stateful control of MPLS TE LSPs. </t>
<t>This document defines a YANG <xref target="RFC6020"/> data model
for the management of PCEP speakers. It is important to
establish a common data model for how PCEP speakers are identified,
configured, and monitored. The data model includes configuration data
and state data (status information and counters for the collection of
statistics).</t>
<t>This document contains a specification of the PCEP YANG module,
"ietf-pcep" which provides the PCEP <xref target="RFC5440"/> data
model.</t>
<t>The PCEP operational state is included in the same tree as the PCEP
configuration consistent with Network Management Datastore
Architecture <xref target="I-D.ietf-netmod-revised-datastores"/>.
The origin of the data is indicated as per the origin metadata
annotation.</t>
</section>
<section title="Requirements Language" toc="default">
<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>
</section>
<section title="Terminology and Notation" toc="default">
<t>
This document uses the terminology defined in <xref target="RFC4655"/>
and <xref target="RFC5440"/>. In particular, it uses the following
acronyms.
<list style='symbols'>
<t>
Path Computation Request message (PCReq).
</t>
<t>
Path Computation Reply message (PCRep).
</t>
<t>
Notification message (PCNtf).
</t>
<t>
Error message (PCErr).
</t>
<t>
Request Parameters object (RP).
</t>
<t>
Synchronization Vector object (SVEC).
</t>
<t>
Explicit Route object (ERO).
</t>
</list>
</t>
<t>
This document also uses the following terms defined in
<xref target="RFC7420"/>:
<list style='symbols'>
<t>
PCEP entity: a local PCEP speaker.
</t>
<t>
PCEP peer: to refer to a remote PCEP speaker.
</t>
<t>PCEP speaker: where it is not necessary to distinguish between local
and remote.
</t>
</list>
</t>
<t>
Further, this document also uses the following terms defined in
<xref target='RFC8231'/> :
<list style='symbols'>
<t>
Stateful PCE, Passive Stateful PCE, Active Stateful PCE
</t>
<t>
Delegation, Revocation, Redelegation
</t>
<t>LSP State Report, Path Computation Report message (PCRpt).</t>
<t>LSP State Update, Path Computation Update message (PCUpd).</t>
</list>
</t>
<t>
<xref target='RFC8281'/> :
<list style='symbols'>
<t>PCE-initiated LSP, Path Computation LSP Initiate Message (PCInitiate).</t>
</list>
</t>
<t>
<xref target='I-D.ietf-pce-lsp-setup-type'/> :
<list style='symbols'>
<t>Path Setup Type (PST).</t>
</list>
</t>
<t>
<xref target='I-D.ietf-pce-segment-routing'/> :
<list style='symbols'>
<t>Segment Routing (SR).</t>
</list>
</t>
<section anchor="sec.tree-symbols" title="Tree Diagrams" toc="default">
<t>A simplified graphical representation of the data model is used in this
document. The meaning of the symbols in these diagrams is defined in <xref target="I-D.ietf-netmod-yang-tree-diagrams"/>.
</t>
<!--
<list style="symbols">
<t>Brackets "[" and "]" enclose list keys.</t>
<t>Abbreviations before data node names: "rw" means
configuration (read-write) and "ro" state data
(read-only).</t>
<t>Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.</t>
<t>Parentheses enclose choice and case nodes, and case nodes
are also marked with a colon (":").</t>
<t>Ellipsis ("...") stands for contents of subtrees that are
not shown.</t>
</list></t>-->
</section>
<section title="Prefixes in Data Node Names" toc="default">
<t>In this document, names of data nodes and other data
model objects are often used without a prefix, as long as it is clear
from the context in which YANG module each name is defined.
Otherwise, names are prefixed using the standard prefix associated
with the corresponding YANG module, as shown in <xref target="tab.prefixes" pageno="false" format="default"/>.</t>
<texttable anchor="tab.prefixes" title="Prefixes and corresponding YANG modules" suppress-title="false" align="center" style="full">
<ttcol align="left">Prefix</ttcol>
<ttcol align="left">YANG module</ttcol>
<ttcol align="left">Reference</ttcol>
<c>yang</c><c>ietf-yang-types</c><c><xref target="RFC6991" pageno="false" format="default"/></c>
<c>inet</c><c>ietf-inet-types</c><c><xref target="RFC6991" pageno="false" format="default"/></c>
<c>te</c><c>ietf-te</c><c><xref target="I-D.ietf-teas-yang-te" pageno="false" format="default"/></c>
<c>te-types</c><c>ietf-te-types</c><c><xref target="I-D.ietf-teas-yang-te" pageno="false" format="default"/></c>
<c>key-chain</c><c>ietf-key-chain</c><c><xref target="RFC8177" pageno="false" format="default"/></c>
<c>nacm</c><c>ietf-netconf-acm</c><c><xref target="RFC6536" pageno="false" format="default"/></c>
<c>tls-server</c><c>ietf-tls-server</c><c><xref target="I-D.ietf-netconf-tls-client-server" pageno="false" format="default"/></c>
<c>tls-client</c><c>ietf-tls-client</c><c><xref target="I-D.ietf-netconf-tls-client-server" pageno="false" format="default"/></c>
</texttable>
</section>
</section>
<section title="Objectives" toc="default">
<t>This section describes some of the design objectives for the model:
<list style="symbols">
<t>In case of existing implementations, it needs to map
the data model defined in this document to their proprietary
native data model. To facilitate such mappings, the data model
should be simple.</t>
<t>The data model should be suitable for new implementations to use
as is.</t>
<t>Mapping to the PCEP MIB Module should be clear.</t>
<t>The data model should allow for static configurations of peers.</t>
<t>The data model should include read-only counters in order to
gather statistics for sent and received PCEP messages,
received messages with errors, and messages that could not be sent
due to errors. This could be in a separate model which
augments the base data model.</t>
<t>It should be fairly straightforward to augment the base data model
for advanced PCE features.</t>
</list>
</t>
</section>
<section title="The Design of PCEP Data Model" toc="default" anchor="sec.data-tree">
<section title="The Overview of PCEP Data Model" toc="default" anchor="sec.overview.data-tree">
<t>The PCEP YANG module defined in this document has all the common
building blocks for the PCEP protocol.
<figure title="" suppress-title="false" align="left" alt="" width="" height="">
<artwork xml:space="preserve" name="" type="" align="left" alt="" width="" height=""><![CDATA[
module: ietf-pcep
+--rw pcep!
+--rw entity
+--rw addr inet:ip-address
+--rw enabled? boolean
+--rw role pcep-role
+--rw description? string
+--rw speaker-entity-id? string
| {stateful-sync-opt}?
+--rw admin-status? pcep-admin-status
+--ro index? uint32
+--ro oper-status? pcep-oper-status
+--rw domain
| +--rw domain* [domain-type domain]
| ...
+--rw capability
| ...
+--rw pce-info
| +--rw scope
| | ...
| +--rw neigh-domains
| | ...
| +--rw path-key {path-key}?
| ...
+--ro lsp-db {stateful}?
| +--ro db-ver? uint64
| | {stateful-sync-opt}?
| +--ro association-list*
| | [id source global-source extended-id]
| | ...
| +--ro lsp* [plsp-id pcc-id]
| ...
+--ro path-keys {path-key}?
| +--ro path-keys* [path-key]
| ...
+--rw peers
+--rw peer* [addr]
+--ro sessions
+--ro session* [initiator]
...
rpcs:
+---x trigger-resync {stateful,stateful-sync-opt}?
+---w input
+---w pcc? -> /pcep/entity/peers/peer/addr
notifications:
+---n pcep-session-up
| ...
+---n pcep-session-down
| ...
+---n pcep-session-local-overload
| ...
+---n pcep-session-local-overload-clear
| ...
+---n pcep-session-peer-overload
| ...
+---n pcep-session-peer-overload-clear
...
]]></artwork>
</figure>
</t>
</section>
<section title="The Full PCEP Data Model" toc="default" anchor="sec.full.data-tree">
<t> The module, "ietf-pcep", defines the basic components of a PCE speaker.
<figure title="" suppress-title="false" align="left" alt="" width="" height="">
<artwork xml:space="preserve" name="" type="" align="left" alt="" width="" height=""><![CDATA[
module: ietf-pcep
+--rw pcep!
+--rw entity
+--rw addr inet:ip-address
+--rw enabled? boolean
+--rw role pcep-role
+--rw description? string
+--rw speaker-entity-id? string
| {stateful-sync-opt}?
+--rw admin-status? pcep-admin-status
+--ro index? uint32
+--ro oper-status? pcep-oper-status
+--rw domain
| +--rw domain* [domain-type domain]
| +--rw domain-type domain-type
| +--rw domain domain
+--rw capability
| +--rw gmpls? boolean {gmpls}?
| +--rw bi-dir? boolean
| +--rw diverse? boolean
| +--rw load-balance? boolean
| +--rw synchronize? boolean {svec}?
| +--rw objective-function? boolean
| | {objective-function}?
| +--rw add-path-constraint? boolean
| +--rw prioritization? boolean
| +--rw multi-request? boolean
| +--rw gco? boolean {gco}?
| +--rw p2mp? boolean {p2mp}?
| +--rw stateful {stateful}?
| | +--rw enabled? boolean
| | +--rw active? boolean
| | +--rw pce-initiated? boolean
| | | {pce-initiated}?
| | +--rw include-db-ver? boolean
| | | {stateful-sync-opt}?
| | +--rw trigger-resync? boolean
| | | {stateful-sync-opt}?
| | +--rw trigger-initial-sync? boolean
| | | {stateful-sync-opt}?
| | +--rw incremental-sync? boolean
| | {stateful-sync-opt}?
| +--rw sr {sr}?
| +--rw enabled? boolean
+--rw pce-info
| +--rw scope
| | +--rw intra-area-scope? boolean
| | +--rw intra-area-pref? uint8
| | +--rw inter-area-scope? boolean
| | +--rw inter-area-scope-default? boolean
| | +--rw inter-area-pref? uint8
| | +--rw inter-as-scope? boolean
| | +--rw inter-as-scope-default? boolean
| | +--rw inter-as-pref? uint8
| | +--rw inter-layer-scope? boolean
| | +--rw inter-layer-pref? uint8
| +--rw neigh-domains
| | +--rw domain* [domain-type domain]
| | +--rw domain-type domain-type
| | +--rw domain domain
| +--rw path-key {path-key}?
| +--rw enabled? boolean
| +--rw discard-timer? uint32
| +--rw reuse-time? uint32
| +--rw pce-id? inet:ip-address
+--rw connect-timer? uint32
+--rw connect-max-retry? uint32
+--rw init-backoff-timer? uint32
+--rw max-backoff-timer? uint32
+--rw open-wait-timer? uint32
+--rw keep-wait-timer? uint32
+--rw keep-alive-timer? uint32
+--rw dead-timer? uint32
+--rw allow-negotiation? boolean
+--rw max-keep-alive-timer? uint32
+--rw max-dead-timer? uint32
+--rw min-keep-alive-timer? uint32
+--rw min-dead-timer? uint32
+--rw sync-timer? uint32 {svec}?
+--rw request-timer? uint32
+--rw max-sessions? uint32
+--rw max-unknown-reqs? uint32
+--rw max-unknown-msgs? uint32
+--rw pcep-notification-max-rate uint32
+--rw stateful-parameter {stateful}?
| +--rw state-timeout? uint32
| +--rw redelegation-timeout? uint32
| +--rw rpt-non-pcep-lsp? boolean
+--rw of-list {objective-function}?
| +--rw objective-function* [of]
| +--rw of objective-function
+--ro lsp-db {stateful}?
| +--ro db-ver? uint64 {stateful-sync-opt}?
| +--ro association-list*
| | [id source global-source extended-id]
| | +--ro type? assoc-type
| | +--ro id uint16
| | +--ro source inet:ip-address
| | +--ro global-source uint32
| | +--ro extended-id string
| | +--ro lsp* [plsp-id pcc-id]
| | +--ro plsp-id -> /pcep/entity/lsp-db/lsp/plsp-id
| | +--ro pcc-id -> /pcep/entity/lsp-db/lsp/pcc-id
| +--ro lsp* [plsp-id pcc-id]
| +--ro plsp-id uint32
| +--ro pcc-id inet:ip-address
| +--ro lsp-ref
| | +--ro source?
| | | -> /te:te/lsps-state/lsp/source
| | +--ro destination?
| | | -> /te:te/lsps-state/lsp/destination
| | +--ro tunnel-id?
| | | -> /te:te/lsps-state/lsp/tunnel-id
| | +--ro lsp-id?
| | | -> /te:te/lsps-state/lsp/lsp-id
| | +--ro extended-tunnel-id? leafref
| +--ro admin-state? boolean
| +--ro operational-state? operational-state
| +--ro delegated
| | +--ro enabled? boolean
| | +--ro peer? -> /pcep/entity/peers/peer/addr
| | +--ro srp-id? uint32
| +--ro initiation {pce-initiated}?
| | +--ro enabled? boolean
| | +--ro peer? -> /pcep/entity/peers/peer/addr
| +--ro symbolic-path-name? string
| +--ro last-error? lsp-error
| +--ro pst? pst
| +--ro association-list*
| [id source global-source extended-id]
| +--ro id
| | -> /pcep/entity/lsp-db/association-list/id
| +--ro source leafref
| +--ro global-source leafref
| +--ro extended-id leafref
+--ro path-keys {path-key}?
| +--ro path-keys* [path-key]
| +--ro path-key uint16
| +--ro cps
| | +--ro explicit-route-objects* [index]
| | +--ro explicit-route-usage? identityref
| | +--ro index uint32
| | +--ro (type)?
| | +--:(numbered)
| | | +--ro numbered-hop
| | | +--ro address? te-types:te-tp-id
| | | +--ro hop-type? te-hop-type
| | | +--ro direction? te-link-direction
| | +--:(as-number)
| | | +--ro as-number-hop
| | | +--ro as-number? binary
| | | +--ro hop-type? te-hop-type
| | +--:(unnumbered)
| | | +--ro unnumbered-hop
| | | +--ro node-id? te-types:te-node-id
| | | +--ro link-tp-id? te-types:te-tp-id
| | | +--ro hop-type? te-hop-type
| | | +--ro direction? te-link-direction
| | +--:(label)
| | +--ro label-hop
| | +--ro te-label
| | +--ro (technology)?
| | | +--:(generic)
| | | +--ro generic?
| | | rt-types:generalized-label
| | +--ro direction? te-label-direction
| +--ro pcc-original? -> /pcep/entity/peers/peer/addr
| +--ro req-id? uint32
| +--ro retrieved? boolean
| +--ro pcc-retrieved? -> /pcep/entity/peers/peer/addr
| +--ro creation-time? yang:timestamp
| +--ro discard-time? uint32
| +--ro reuse-time? uint32
+--rw peers
+--rw peer* [addr]
+--rw addr inet:ip-address
+--rw role pcep-role
+--rw description? string
+--rw domain
| +--rw domain* [domain-type domain]
| +--rw domain-type domain-type
| +--rw domain domain
+--rw capability
| +--rw gmpls? boolean {gmpls}?
| +--rw bi-dir? boolean
| +--rw diverse? boolean
| +--rw load-balance? boolean
| +--rw synchronize? boolean {svec}?
| +--rw objective-function? boolean
| | {objective-function}?
| +--rw add-path-constraint? boolean
| +--rw prioritization? boolean
| +--rw multi-request? boolean
| +--rw gco? boolean {gco}?
| +--rw p2mp? boolean {p2mp}?
| +--rw stateful {stateful}?
| | +--rw enabled? boolean
| | +--rw active? boolean
| | +--rw pce-initiated? boolean
| | | {pce-initiated}?
| | +--rw include-db-ver? boolean
| | | {stateful-sync-opt}?
| | +--rw trigger-resync? boolean
| | | {stateful-sync-opt}?
| | +--rw trigger-initial-sync? boolean
| | | {stateful-sync-opt}?
| | +--rw incremental-sync? boolean
| | {stateful-sync-opt}?
| +--rw sr {sr}?
| +--rw enabled? boolean
+--rw pce-info
| +--rw scope
| | +--rw intra-area-scope? boolean
| | +--rw intra-area-pref? uint8
| | +--rw inter-area-scope? boolean
| | +--rw inter-area-scope-default? boolean
| | +--rw inter-area-pref? uint8
| | +--rw inter-as-scope? boolean
| | +--rw inter-as-scope-default? boolean
| | +--rw inter-as-pref? uint8
| | +--rw inter-layer-scope? boolean
| | +--rw inter-layer-pref? uint8
| +--rw neigh-domains
| +--rw domain* [domain-type domain]
| +--rw domain-type domain-type
| +--rw domain domain
+--rw delegation-pref? uint8 {stateful}?
+--rw auth
| +--rw (auth-type-selection)?
| +--:(auth-key-chain)
| | +--rw key-chain?
| | key-chain:key-chain-ref
| +--:(auth-key)
| | +--rw crypto-algorithm identityref
| | +--rw key-string
| | +--rw (key-string-style)?
| | +--:(keystring)
| | | +--rw keystring? string
| | +--:(hexadecimal)
| | {key-chain:hex-key-string}?
| | +--rw hexadecimal-string?
| | yang:hex-string
| +--:(auth-tls) {tls}?
| +--rw (role)?
| +--:(server)
| | +--rw tls-server
| | +--rw server-identity
| | | +--rw algorithm?
| | | | identityref
| | | +--rw private-key?
| | | | union
| | | +--rw public-key?
| | | | binary
| | | +---x generate-private-key
| | | | +---w input
| | | | +---w algorithm
| | | | identityref
| | | +--rw certificates
| | | | +--rw certificate* [name]
| | | | +--rw name string
| | | | +--rw value? binary
| | | +---x generate-certificate-signing-request
| | | +---w input
| | | | +---w subject binary
| | | | +---w attributes? binary
| | | +--ro output
| | | +--ro certificate-signing-request
| | | binary
| | +--rw client-auth
| | | +--rw pinned-ca-certs?
| | | | ks:pinned-certificates
| | | +--rw pinned-client-certs?
| | | ks:pinned-certificates
| | +--rw hello-params
| | {tls-server-hello-params-config}?
| | +--rw tls-versions
| | | +--rw tls-version* identityref
| | +--rw cipher-suites
| | +--rw cipher-suite*
| | identityref
| +--:(client)
| +--rw tls-client
| +--rw client-identity
| | +--rw (auth-type)?
| | +--:(certificate)
| | +--rw certificate
| | +--rw algorithm?
| | | identityref
| | +--rw private-key?
| | | union
| | +--rw public-key?
| | | binary
| | +---x generate-private-key
| | | +---w input
| | | +---w algorithm
| | | identityref
| | +--rw certificates
| | | +--rw certificate*
| | | [name]
| | | +--rw name
| | | | string
| | | +--rw value?
| | | binary
| | +---x generate-certificate-signing-request
| | +---w input
| | | +---w subject
| | | | binary
| | | +---w attributes?
| | | binary
| | +--ro output
| | +--ro certificate-signing-request
| | binary
| +--rw server-auth
| | +--rw pinned-ca-certs?
| | | ks:pinned-certificates
| | +--rw pinned-server-certs?
| | ks:pinned-certificates
| +--rw hello-params
| {tls-client-hello-params-config}?
| +--rw tls-versions
| | +--rw tls-version* identityref
| +--rw cipher-suites
| +--rw cipher-suite*
| identityref
+--ro discontinuity-time? yang:timestamp
+--ro initiate-session? boolean
+--ro session-exists? boolean
+--ro session-up-time? yang:timestamp
+--ro session-fail-time? yang:timestamp
+--ro session-fail-up-time? yang:timestamp
+--ro sessions
+--ro session* [initiator]
+--ro initiator pcep-initiator
+--ro role? -> /pcep/entity/role
+--ro state-last-change? yang:timestamp
+--ro state? pcep-sess-state
+--ro session-creation? yang:timestamp
+--ro connect-retry? yang:counter32
+--ro local-id? uint32
+--ro remote-id? uint32
+--ro keepalive-timer? uint32
+--ro peer-keepalive-timer? uint32
+--ro dead-timer? uint32
+--ro peer-dead-timer? uint32
+--ro ka-hold-time-rem? uint32
+--ro overloaded? boolean
+--ro overload-time? uint32
+--ro peer-overloaded? boolean
+--ro peer-overload-time? uint32
+--ro lspdb-sync? sync-state
| {stateful}?
+--ro recv-db-ver? uint64
| {stateful,stateful-sync-opt}?
+--ro of-list {objective-function}?
| +--ro objective-function* [of]
| +--ro of objective-function
+--ro speaker-entity-id? string
| {stateful-sync-opt}?
+--ro discontinuity-time? yang:timestamp
rpcs:
+---x trigger-resync {stateful,stateful-sync-opt}?
+---w input
+---w pcc? -> /pcep/entity/peers/peer/addr
notifications:
+---n pcep-session-up
| +--ro peer-addr? -> /pcep/entity/peers/peer/addr
| +--ro session-initiator?
| | -> /pcep/entity/peers/peer/sessions/session/initiator
| +--ro state-last-change? yang:timestamp
| +--ro state? pcep-sess-state
+---n pcep-session-down
| +--ro peer-addr? -> /pcep/entity/peers/peer/addr
| +--ro session-initiator? pcep-initiator
| +--ro state-last-change? yang:timestamp
| +--ro state? pcep-sess-state
+---n pcep-session-local-overload
| +--ro peer-addr? -> /pcep/entity/peers/peer/addr
| +--ro session-initiator?
| | -> /pcep/entity/peers/peer/sessions/session/initiator
| +--ro overloaded? boolean
| +--ro overload-time? uint32
+---n pcep-session-local-overload-clear
| +--ro peer-addr? -> /pcep/entity/peers/peer/addr
| +--ro overloaded? boolean
+---n pcep-session-peer-overload
| +--ro peer-addr? -> /pcep/entity/peers/peer/addr
| +--ro session-initiator?
| | -> /pcep/entity/peers/peer/sessions/session/initiator
| +--ro peer-overloaded? boolean
| +--ro peer-overload-time? uint32
+---n pcep-session-peer-overload-clear
+--ro peer-addr? -> /pcep/entity/peers/peer/addr
+--ro peer-overloaded? boolean
]]></artwork>
</figure>
</t>
</section>
<section title="The Entity" toc="default">
<t>The PCEP yang module may contain status information for the
local PCEP entity.</t>
<t>The entity has an IP address
(using ietf-inet-types <xref target="RFC6991"/>) and a "role"
leaf (the local entity PCEP role) as mandatory. </t>
<t>Note that, the PCEP MIB module <xref target="RFC7420"/> uses an
entity list and a system generated entity index as a primary index
to the read only entity
table. If the device implements the PCEP MIB, the "index" leaf MUST contain
the value of the corresponding pcePcepEntityIndex and only one entity
is assumed.</t>
</section>
<section title="The Peer Lists" toc="default">
<t>
The peer list contains peer(s) that the
local PCEP entity knows about. A PCEP speaker is identified by its
IP address. If there is a PCEP
speaker in the network that uses multiple IP addresses
then it looks like multiple distinct peers to the other PCEP
speakers in the network.
</t>
<t>
Since PCEP sessions
can be ephemeral, the peer list tracks a peer even when no
PCEP session currently exists to that peer. The statistics contained
are an aggregate of the statistics for all
successive sessions to that peer.
</t>
<t>
To limit the quantity of information that is stored, an
implementation MAY choose to discard this information
if and only if no PCEP session exists to the corresponding peer.
</t>
<t>The data model for PCEP peer presented in this document uses a flat
list of peers. Each peer in the list is identified by its
IP address (addr-type, addr).</t>
<t> There is a list for static peer configuration and operational state of
all peers (i.e.static as well as discovered)("/pcep/entity/peers"). The list
is used to enable remote PCE configuration at PCC (or PCE) and has the
operational state of these peers as well as the remote PCE peer which were
discovered and PCC peers that have initiated session.</t>
</section>
<section title="The Session Lists" toc="default">
<t>
The session list contains PCEP session that the
PCEP entity (PCE or PCC) is currently participating in.
The statistics in
session are semantically different from those in
peer since the former applies to the current session only,
whereas the latter is the aggregate for all sessions that have
existed to that peer.
</t>
<t>
Although <xref target="RFC5440"/> forbids more than one
active PCEP session between a given pair of PCEP entities
at any given time, there is a window during session
establishment where two sessions may exist for a given pair,
one representing a session initiated by the local PCEP
entity and the other representing a session initiated by
the peer. If either of these sessions reaches active state
first, then the other is discarded.
</t>
<t>The data model for PCEP session presented in this document uses a flat
list of sessions. Each session in the list is identified by its
initiator. This index allows two sessions to exist transiently for a
given peer, as discussed above.</t>
</section>
<section title="Notifications" toc="default">
<t>This YANG model defines a list of notifications to inform client of
important events detected during the protocol operation. The
notifications defined cover the PCEP MIB notifications.</t>
</section>
<section title="RPC" toc="default">
<t>This YANG model defines a RPC to trigger state resynchronization to
a particular PCEP peer.</t>
</section>
</section>
<section title="The Design of PCEP Statistics Data Model" toc="default" anchor="sec.data-tree-stat">
<t> The module, "ietf-pcep-stats", augments the ietf-pcep module to include statistics at the
PCEP peer and session level.
<figure title="" suppress-title="false" align="left" alt="" width="" height="">
<artwork xml:space="preserve" name="" type="" align="left" alt="" width="" height=""><![CDATA[
module: ietf-pcep-stats
augment /p:pcep/p:entity/p:peers/p:peer:
+--ro num-sess-setup-ok? yang:counter32
+--ro num-sess-setup-fail? yang:counter32
+--ro pcep-stats
+--ro avg-rsp-time? uint32
+--ro lwm-rsp-time? uint32
+--ro hwm-rsp-time? uint32
+--ro num-pcreq-sent? yang:counter32
+--ro num-pcreq-rcvd? yang:counter32
+--ro num-pcrep-sent? yang:counter32
+--ro num-pcrep-rcvd? yang:counter32
+--ro num-pcerr-sent? yang:counter32
+--ro num-pcerr-rcvd? yang:counter32
+--ro num-pcntf-sent? yang:counter32
+--ro num-pcntf-rcvd? yang:counter32
+--ro num-keepalive-sent? yang:counter32
+--ro num-keepalive-rcvd? yang:counter32
+--ro num-unknown-rcvd? yang:counter32
+--ro num-corrupt-rcvd? yang:counter32
+--ro num-req-sent? yang:counter32
+--ro num-req-sent-pend-rep? yang:counter32
+--ro num-req-sent-ero-rcvd? yang:counter32
+--ro num-req-sent-nopath-rcvd? yang:counter32
+--ro num-req-sent-cancel-rcvd? yang:counter32
+--ro num-req-sent-error-rcvd? yang:counter32
+--ro num-req-sent-timeout? yang:counter32
+--ro num-req-sent-cancel-sent? yang:counter32
+--ro num-req-rcvd? yang:counter32
+--ro num-req-rcvd-pend-rep? yang:counter32
+--ro num-req-rcvd-ero-sent? yang:counter32
+--ro num-req-rcvd-nopath-sent? yang:counter32
+--ro num-req-rcvd-cancel-sent? yang:counter32
+--ro num-req-rcvd-error-sent? yang:counter32
+--ro num-req-rcvd-cancel-rcvd? yang:counter32
+--ro num-rep-rcvd-unknown? yang:counter32
+--ro num-req-rcvd-unknown? yang:counter32
+--ro svec {p:svec}?
| +--ro num-svec-sent? yang:counter32
| +--ro num-svec-req-sent? yang:counter32
| +--ro num-svec-rcvd? yang:counter32
| +--ro num-svec-req-rcvd? yang:counter32
+--ro stateful {p:stateful}?
| +--ro num-pcrpt-sent? yang:counter32
| +--ro num-pcrpt-rcvd? yang:counter32
| +--ro num-pcupd-sent? yang:counter32
| +--ro num-pcupd-rcvd? yang:counter32
| +--ro num-rpt-sent? yang:counter32
| +--ro num-rpt-rcvd? yang:counter32
| +--ro num-rpt-rcvd-error-sent? yang:counter32
| +--ro num-upd-sent? yang:counter32
| +--ro num-upd-rcvd? yang:counter32
| +--ro num-upd-rcvd-unknown? yang:counter32
| +--ro num-upd-rcvd-undelegated? yang:counter32
| +--ro num-upd-rcvd-error-sent? yang:counter32
| +--ro initiation {p:pce-initiated}?
| +--ro num-pcinitiate-sent? yang:counter32
| +--ro num-pcinitiate-rcvd? yang:counter32
| +--ro num-initiate-sent? yang:counter32
| +--ro num-initiate-rcvd? yang:counter32
| +--ro num-initiate-rcvd-error-sent? yang:counter32
+--ro path-key {p:path-key}?
| +--ro num-unknown-path-key? yang:counter32
| +--ro num-exp-path-key? yang:counter32
| +--ro num-dup-path-key? yang:counter32
| +--ro num-path-key-no-attempt? yang:counter32
+--ro num-req-sent-closed? yang:counter32
+--ro num-req-rcvd-closed? yang:counter32
augment /p:pcep/p:entity/p:peers/p:peer/p:sessions/p:session:
+--ro pcep-stats
+--ro avg-rsp-time? uint32
+--ro lwm-rsp-time? uint32
+--ro hwm-rsp-time? uint32
+--ro num-pcreq-sent? yang:counter32
+--ro num-pcreq-rcvd? yang:counter32
+--ro num-pcrep-sent? yang:counter32
+--ro num-pcrep-rcvd? yang:counter32
+--ro num-pcerr-sent? yang:counter32
+--ro num-pcerr-rcvd? yang:counter32
+--ro num-pcntf-sent? yang:counter32
+--ro num-pcntf-rcvd? yang:counter32
+--ro num-keepalive-sent? yang:counter32
+--ro num-keepalive-rcvd? yang:counter32
+--ro num-unknown-rcvd? yang:counter32
+--ro num-corrupt-rcvd? yang:counter32
+--ro num-req-sent? yang:counter32
+--ro num-req-sent-pend-rep? yang:counter32
+--ro num-req-sent-ero-rcvd? yang:counter32
+--ro num-req-sent-nopath-rcvd? yang:counter32
+--ro num-req-sent-cancel-rcvd? yang:counter32
+--ro num-req-sent-error-rcvd? yang:counter32
+--ro num-req-sent-timeout? yang:counter32
+--ro num-req-sent-cancel-sent? yang:counter32
+--ro num-req-rcvd? yang:counter32
+--ro num-req-rcvd-pend-rep? yang:counter32
+--ro num-req-rcvd-ero-sent? yang:counter32
+--ro num-req-rcvd-nopath-sent? yang:counter32
+--ro num-req-rcvd-cancel-sent? yang:counter32
+--ro num-req-rcvd-error-sent? yang:counter32
+--ro num-req-rcvd-cancel-rcvd? yang:counter32
+--ro num-rep-rcvd-unknown? yang:counter32
+--ro num-req-rcvd-unknown? yang:counter32
+--ro svec {p:svec}?
| +--ro num-svec-sent? yang:counter32
| +--ro num-svec-req-sent? yang:counter32
| +--ro num-svec-rcvd? yang:counter32
| +--ro num-svec-req-rcvd? yang:counter32
+--ro stateful {p:stateful}?
| +--ro num-pcrpt-sent? yang:counter32
| +--ro num-pcrpt-rcvd? yang:counter32
| +--ro num-pcupd-sent? yang:counter32
| +--ro num-pcupd-rcvd? yang:counter32
| +--ro num-rpt-sent? yang:counter32
| +--ro num-rpt-rcvd? yang:counter32
| +--ro num-rpt-rcvd-error-sent? yang:counter32
| +--ro num-upd-sent? yang:counter32
| +--ro num-upd-rcvd? yang:counter32
| +--ro num-upd-rcvd-unknown? yang:counter32
| +--ro num-upd-rcvd-undelegated? yang:counter32
| +--ro num-upd-rcvd-error-sent? yang:counter32
| +--ro initiation {p:pce-initiated}?
| +--ro num-pcinitiate-sent? yang:counter32
| +--ro num-pcinitiate-rcvd? yang:counter32
| +--ro num-initiate-sent? yang:counter32
| +--ro num-initiate-rcvd? yang:counter32
| +--ro num-initiate-rcvd-error-sent? yang:counter32
+--ro path-key {p:path-key}?
+--ro num-unknown-path-key? yang:counter32
+--ro num-exp-path-key? yang:counter32
+--ro num-dup-path-key? yang:counter32
+--ro num-path-key-no-attempt? yang:counter32
]]></artwork></figure></t>
</section>
<section title="Advanced PCE Features" toc="default">
<t>This document contains a specification of the base PCEP YANG module,
"ietf-pcep" which provides the basic PCEP <xref target="RFC5440"/> data
model.</t>
<t>This document further handles advanced PCE features like -
<list style="symbols">
<t>Capability and Scope</t>
<t>Domain information (local/neighbour) </t>
<t>Path-Key</t>
<t>OF</t>
<t>GCO</t>
<t>P2MP</t>
<t>GMPLS</t>
<t>Inter-Layer</t>
<t>Stateful PCE</t>
<t>Segement Routing</t>
<t>Authentication including PCEPS (TLS)</t>
</list>
</t>
<section title="Stateful PCE's LSP-DB" toc="default">
<t>In the operational state of PCEP which supports stateful PCE mode, the
list of LSP state are maintained in LSP-DB. The key is the PLSP-ID and the
PCC IP address.</t>
<t>The PCEP data model contains the operational state
of LSPs (/pcep/entity/lsp-db/lsp/) with PCEP specific
attributes. The generic TE attributes of the LSP are defined
in <xref target="I-D.ietf-teas-yang-te"/>. A reference to LSP
state in TE model is maintained.</t>
</section></section>
<section title="Open Issues and Next Step" toc="default">
<t>This section is added so that open issues can be tracked.
This section would be removed when the document is ready for publication.</t>