2 namespace "urn:onf:otcc:yang:tapi-odu";
\r
7 import tapi-connectivity {
\r
8 prefix tapi-connectivity;
\r
10 import tapi-topology {
\r
11 prefix tapi-topology;
\r
19 organization "ONF OTCC (Open Transport Configuration & Control) Project";
\r
21 Project Web: <https://wiki.opennetworking.org/display/OTCC/TAPI>
22 Project List: <mailto:transport-api@opennetworking.org>
23 Editor: Karthik Sethuraman
24 <mailto:karthik.sethuraman@necam.com>";
\r
26 This module contains TAPI Odu Model definitions.
\r
28 Copyright (c) 2018 Open Networking Foundation (ONF). All rights reserved.
\r
29 License: This module is distributed under the Apache License 2.0";
\r
30 revision 2018-08-31 {
\r
31 description "ONF Transport API version 2.1.0
32 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
33 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.0.md>";
\r
34 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
35 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";
\r
37 revision 2018-03-07 {
\r
38 description "ONF Transport API version 2.0.2
39 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
40 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.2.md>";
\r
41 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
42 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.2/UML>";
\r
44 revision 2018-02-16 {
\r
45 description "ONF Transport API version 2.0.1
46 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
47 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.1.md>";
\r
48 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
49 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.1/UML>";
\r
51 revision 2018-01-02 {
\r
52 description "ONF Transport API version 2.0.0
53 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
54 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.0.md>";
\r
55 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
56 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.0/UML>";
\r
58 augment "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point" {
\r
59 uses odu-node-edge-point-spec-g;
\r
60 description "Augments the base LayerProtocol information in NodeEdgePoint with ODU-specific information";
\r
62 augment "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:connection-end-point" {
\r
63 uses odu-connection-end-point-spec-g;
\r
66 augment "/tapi-common:context/tapi-oam:meg/tapi-oam:mep" {
\r
67 uses odu-connection-end-point-spec-g;
\r
70 augment "/tapi-common:context/tapi-oam:meg/tapi-oam:mip" {
\r
71 uses odu-mip-spec-g;
\r
74 /***********************
\r
75 * package object-classes
\r
76 **********************/
\r
77 grouping odu-termination-and-client-adaptation-pac-g {
\r
78 leaf opu-tributary-slot-size {
\r
81 description "This attribute is applicable for ODU2 and ODU3 CTP only. It indicates the slot size of the ODU CTP.";
\r
83 leaf auto-payload-type {
\r
86 description "This attribute is applicable when the ODU CTP object instance represents a lower order ODU CTP Source at the client layer of the ODUP/ODUj-21 adaptation function. The value of true of this attribute configures that the adaptation source function shall fall back to the payload type PT=20 if the conditions specified in 14.3.10.1/G.798 are satisfied. ";
\r
88 leaf configured-client-type {
\r
89 type tapi-dsr:digital-signal-type;
\r
91 description "This attribute configures the type of the client CTP of the server ODU TTP.";
\r
93 leaf configured-mapping-type {
\r
96 description "This attributes indicates the configured mapping type.";
\r
98 container accepted-payload-type {
\r
100 uses odu-payload-type-g;
\r
101 description "This attribute is applicable when the ODU CTP object instance represents a lower order ODU CTP Sink at the client layer of the ODUP/ODU[i]j or ODUP/ODUj-21 adaptation function.
\r
102 This attribute is a 2-digit Hex code that indicates the new accepted payload type.
\r
103 Valid values are defined in Table 15-8 of ITU-T Recommendation G.709 with one additional value UN_INTERPRETABLE.";
\r
105 description "This Pac contains the attributes associated with the client adaptation function of the server layer TTP
\r
106 It is present only if the CEP contains a TTP";
\r
108 grouping odu-connection-end-point-spec-g {
\r
109 container odu-common {
\r
110 uses odu-common-pac-g;
\r
111 description "none";
\r
113 container odu-term-and-adapter {
\r
115 uses odu-termination-and-client-adaptation-pac-g;
\r
116 description "none";
\r
118 container odu-ctp {
\r
120 uses odu-ctp-pac-g;
\r
121 description "none";
\r
123 container odu-protection {
\r
125 uses odu-protection-pac-g;
\r
126 description "none";
\r
128 description "none";
\r
130 grouping odu-pool-pac-g {
\r
131 leaf client-capacity {
\r
133 description "none";
\r
135 leaf max-client-instances {
\r
138 description "none";
\r
140 leaf max-client-size {
\r
143 description "none";
\r
145 description "none";
\r
147 grouping odu-node-edge-point-spec-g {
\r
148 container odu-pool {
\r
150 uses odu-pool-pac-g;
\r
151 description "none";
\r
153 description "none";
\r
155 grouping odu-ctp-pac-g {
\r
156 leaf-list tributary-slot-list {
\r
159 description "This attribute contains a set of distinct (i.e. unique) integers (e.g. 2, 3, 5, 9, 15 representing the tributary slots TS2, TS3, TS5, TS9 and TS15) which represents the resources occupied by the Low Order ODU Link Connection (e.g. carrying an ODUflex with a bit rate of 6.25G).
\r
160 This attribute applies when the LO ODU_ ConnectionTerminationPoint connects with an HO ODU_TrailTerminationPoint object.
\r
161 It will not apply if this ODU_ ConnectionTerminationPoint object directly connects to an OTU_TrailTerminationPoint object (i.e. OTU has no trib slots).
\r
162 The upper bound of the integer allowed in this set is a function of the HO-ODU server layer to which the ODU connection has been mapped (adapted).
\r
163 Thus, for example, M=8/32/80 for ODU2/ODU3/ODU4 server layers (respectively). Note that the value of this attribute can be changed only in the case of ODUflex and has to be through specific operations (i.e. not be changing the attribute tributarySlotList directly).";
\r
165 leaf tributary-port-number {
\r
168 description "This attribute identifies the tributary port number that is associated with the ODU CTP.
\r
169 range of type : The value range depends on the size of the Tributary Port Number (TPN) field used which depends on th server-layer ODU or OTU.
\r
170 In case of ODUk mapping into OTUk, there is no TPN field, so the tributaryPortNumber shall be zero.
\r
171 In case of LO ODUj mapping over ODU1, ODU2 or ODU3, the TPN is encoded in a 6-bit field so the value range is 0-63. See clause 14.4.1/G.709-2016.
\r
172 In case of LO ODUj mapping over ODU4, the TPN is encoded in a 7-bit field so the value range is 0-127. See clause 14.4.1.4/G.709-2016.
\r
173 In case of ODUk mapping over ODUCn, the TPN is encoded in a 14-bit field so the value range is 0-16383. See clause 20.4.1.1/G.709-2016.
\r
176 leaf accepted-msi {
\r
179 description "This attribute is applicable when the ODU CTP object instance represents a lower order ODU1 or ODU2 CTP Sink at the client layer of the ODU3P/ODU12 adaptation function or represents a lower order ODUj CTP Sink at the client layer of the ODUP/ODUj-21 adaptation function. This attribute is a 1-byte field that represents the accepted multiplex structure of the adaptation function. ";
\r
181 description "This Pac contains the attributes associated with the CTP
\r
182 It is present only if the CEP contains a CTP";
\r
184 grouping odu-mep-spec-g {
\r
185 container odu-mep {
\r
186 uses odu-mep-pac-g;
\r
187 description "none";
\r
189 container odu-ncm {
\r
191 uses odu-ncm-pac-g;
\r
192 description "none";
\r
194 container odu-tcm {
\r
196 uses odu-tcm-mep-pac-g;
\r
197 description "none";
\r
199 container odu-defect {
\r
200 uses odu-defect-pac-g;
\r
201 description "none";
\r
205 description "none";
\r
207 description "none";
\r
209 grouping odu-protection-pac-g {
\r
213 description "This attribute is for enabling/disabling the automatic protection switching (APS) capability at the transport adaptation function that is represented by the ODU_ConnectionTerminationPoint object class. It triggers the MI_APS_EN signal to the transport adaptation function.";
\r
217 description "This attribute is for configuring the automatic protection switching (APS) level that should operate at the transport adaptation function that is represented by the ODU_ConnectionTerminationPoint object class. It triggers the MI_APS_LVL signal to the transport adaptation function. The value 0 means path and the values 1 through 6 mean TCM level 1 through 6 respectively.";
\r
219 description "none";
\r
221 grouping odu-ncm-pac-g {
\r
222 leaf-list tcm-fields-in-use {
\r
225 description "This attribute indicates the used TCM fields of the ODU OH.";
\r
227 description "none";
\r
229 grouping odu-tcm-mep-pac-g {
\r
230 leaf tcm-extension {
\r
231 type tcm-extension;
\r
232 description "none";
\r
236 description "This attribute specifies the TCM mode at the entity. Valid values are: Operational, Monitor, and Transparent.";
\r
238 leaf codirectional {
\r
241 description "This attribute specifies the directionality of the ODUT MEP with respect to the associated ODU CEP. The value of TRUE means that the sink part of the ODUT MEP terminates the same signal direction as the sink part of the ODU CEP. The Source part behaves similarly. This attribute is meaningful only on objects instantiated under ODU CEP, and at least one among ODU CEP and the subordinate object is bidirectional.";
\r
243 leaf ac-status-source {
\r
246 description "This attribute indicates the status of the accepted TCM. ";
\r
248 leaf ac-status-sink {
\r
251 description "This attribute indicates the status of the accepted TCM. ";
\r
253 leaf admin-state-source {
\r
254 type tapi-common:administrative-state;
\r
255 description "This attribute provides the capability to provision the LOCK signal at the source, which is one of the ODU maintenance signals. When a Tandem Connection endpoint is set to admin state locked, it will insert the ODU-LCK signal in the source direction.";
\r
257 leaf admin-state-sink {
\r
258 type tapi-common:administrative-state;
\r
259 description "This attribute provides the capability to provision the LOCK signal at the sink, which is one of the ODU maintenance signals. When a Tandem Connection endpoint is set to admin state locked, it will insert the ODU-LCK signal in the downstream direction.";
\r
261 uses odu-tcm-mip-pac-g;
\r
262 description "none";
\r
264 grouping odu-mip-spec-g {
\r
265 container odu-mip {
\r
267 uses odu-mip-pac-g;
\r
268 description "none";
\r
270 container odu-ncm {
\r
272 uses odu-ncm-pac-g;
\r
273 description "none";
\r
275 container odu-tcm {
\r
277 uses odu-tcm-mip-pac-g;
\r
278 description "none";
\r
282 description "none";
\r
284 container odu-defect {
\r
285 uses odu-defect-pac-g;
\r
286 description "none";
\r
288 description "none";
\r
290 grouping odu-mip-pac-g {
\r
294 description "The Trail Trace Identifier (TTI) information recovered (Accepted) from the TTI overhead position at the sink of a trail.";
\r
298 description "The Expected Destination Access Point Identifier (ExDAPI), provisioned by the managing system, to be compared with the TTI accepted at the overhead position of the sink for the purpose of checking the integrity of connectivity.";
\r
302 description "The Expected Source Access Point Identifier (ExSAPI), provisioned by the managing system, to be compared with the TTI accepted at the overhead position of the sink for the purpose of checking the integrity of connectivity.
\r
305 leaf tim-act-disabled {
\r
308 description "This attribute provides the control capability for the managing system to enable or disable the Consequent Action function when detecting Trace Identifier Mismatch (TIM) at the trail termination sink.";
\r
310 leaf tim-det-mode {
\r
312 description "This attribute indicates the mode of the Trace Identifier Mismatch (TIM) Detection function allowed values: OFF, SAPIonly, DAPIonly, SAPIandDAPI";
\r
316 description "This attribute indicates the threshold level for declaring a Degraded Signal defect (dDEG). A dDEG shall be declared if DegM consecutive bad PM Seconds are detected.";
\r
318 container deg-thr {
\r
320 description "This attribute indicates the threshold level for declaring a performance monitoring (PM) Second to be bad. The value of the threshold can be provisioned in terms of number of errored blocks or in terms of percentage of errored blocks. For percentage-based specification, in order to support provision of less than 1%, the specification consists of two fields. The first field indicates the granularity of percentage. For examples, in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple of the granularity. For number of errored block based, the value is a positive integer.";
\r
322 description "none";
\r
324 grouping odu-tcm-mip-pac-g {
\r
328 description "This attribute indicates the tandem connection monitoring field of the ODU OH.";
\r
330 description "none";
\r
332 grouping odu-mep-pac-g {
\r
335 description "This attribute is for configuring the delay measurement process at the trail termination function represented by the subject TTP object class. It models the MI_DM_Source MI signal. If MI_DM_Source is false, then the value of the DMp bit is determined by the RI_DM. If MI_DM_Source is true, then the value of the DMp bit is set to MI_DMValue.";
\r
339 description "This attribute is for setting the DMp and DMti bits of the delay measurement process. The value of 'true' sets the DMp and DMti bits to 0 and the value of 'false' to 1.";
\r
343 description "The Trail Trace Identifier (TTI) information, provisioned by the managing system at the termination source, to be placed in the TTI overhead position of the source of a trail for transmission.
\r
346 uses odu-mip-pac-g;
\r
347 description "none";
\r
349 grouping odu-common-pac-g {
\r
353 description "This attribute specifies the type of the ODU termination point.";
\r
358 description "This attribute indicates the rate of the ODU terminatino point.
\r
359 This attribute is Set at create; i.e., once created it cannot be changed directly.
\r
360 In case of resizable ODU flex, its value can be changed via HAO (not directly on the attribute).
\r
363 leaf odu-rate-tolerance {
\r
366 description "This attribute indicates the rate tolerance of the ODU termination point.
\r
367 Valid values are real value in the unit of ppm.
\r
368 Standardized values are defined in Table 7-2/G.709.";
\r
370 description "none";
\r
372 grouping odu-pm-pac-g {
\r
375 description "Near-end Background Block Error";
\r
380 description "Far-end Background Block Error";
\r
384 description "Near-end Severely Errored Second";
\r
388 description "Far-end Severely Errored Second";
\r
392 description "UnAvailable Second";
\r
394 description "Instance of this object class contains the ODUP layer-specific Current Data. This object class is a subclass of the OTN_CurrentData object class.
\r
395 PM data attributes: fBbe, fSes, nBbe, nSes. uas";
\r
397 grouping odu-defect-pac-g {
\r
401 description "Backward Defect Indication";
\r
406 description "Signal Degraded";
\r
411 description "Locked";
\r
416 description "Open Connection Indicator";
\r
421 description "Server Signal Failure";
\r
426 description "Trail Trace Identifier Mismatch";
\r
428 description "The valid list of defects raised on the entity. If the value of any attribute is true, then the corresponding defect is raised.";
\r
431 /***********************
\r
432 * package type-definitions
\r
433 **********************/
\r
434 identity ODU_TYPE {
\r
435 base tapi-common:LAYER_PROTOCOL_QUALIFIER;
\r
436 description "none";
\r
438 identity ODU_TYPE_ODU0 {
\r
440 description "none";
\r
442 identity ODU_TYPE_ODU1 {
\r
444 description "none";
\r
446 identity ODU_TYPE_ODU2 {
\r
448 description "none";
\r
450 identity ODU_TYPE_ODU2E {
\r
452 description "none";
\r
454 identity ODU_TYPE_ODU3 {
\r
456 description "none";
\r
458 identity ODU_TYPE_ODU4 {
\r
460 description "none";
\r
462 identity ODU_TYPE_ODU_FLEX {
\r
464 description "none";
\r
466 identity ODU_TYPE_ODU_CN {
\r
468 description "none";
\r
474 description "none";
\r
476 typedef mapping-type {
\r
479 description "none";
\r
482 description "none";
\r
485 description "none";
\r
488 description "none";
\r
491 description "none";
\r
494 description "none";
\r
497 description "none";
\r
499 typedef tim-det-mo {
\r
502 description "none";
\r
505 description "none";
\r
508 description "none";
\r
511 description "none";
\r
514 description "List of modes for trace identifier mismatch detection.";
\r
516 typedef odu-slot-size {
\r
519 description "none";
\r
522 description "none";
\r
525 description "none";
\r
527 grouping odu-payload-type-g {
\r
528 leaf named-payload-type {
\r
529 type odu-named-payload-type;
\r
530 description "none";
\r
532 leaf hex-payload-type {
\r
534 description "none";
\r
536 description "none";
\r
538 typedef odu-named-payload-type {
\r
541 description "none";
\r
543 enum UNINTERPRETABLE {
\r
544 description "none";
\r
547 description "none";
\r
549 grouping deg-thr-g {
\r
550 leaf deg-thr-value {
\r
552 description "Percentage of detected errored blocks";
\r
554 leaf deg-thr-type {
\r
556 description "Number of errored blocks";
\r
558 leaf percentage-granularity {
\r
559 type percentage-granularity;
\r
560 description "none";
\r
562 description "Degraded Threshold, specify either the percentage or the number of Errored Blocks in the defined interval.
\r
563 degThrValue when type is PERCENTAGE:
\r
564 percentageGranularity is used to indicate the number of decimal points
\r
565 So if percentageGranularity is ones, a value of 1 in degThrValue would indicate 1%, a value of 10 = 10%, a value of 100 = 100%
\r
566 So if percentageGranularity is thousandths a value of 1 in degThrValue would indicate 0.001%, a value of 1000 = 1%, a value of 1000000 = 100%
\r
567 degThrValue when type is NUMBER_ERROR_BLOCKS:
\r
568 Number of Errored Blocks is captured in an integer value.";
\r
570 typedef deg-thr-type {
\r
573 description "Choice of % or Number of errored blocks";
\r
575 enum NUMBER_ERRORED_BLOCKS {
\r
576 description "Number of % or blocks";
\r
579 description "The value of the threshold can be provisioned in terms of number of errored blocks or in terms of percentage of errored blocks. For percentage-based specification, in order to support provision of less than 1%, the specification consists of two fields. The first field indicates the granularity of percentage. For examples, in 1%, in 0.1%, or in 0.01%, etc. The second field indicates the multiple of the granularity. For number of errored block based, the value is a positive integer.";
\r
581 typedef tcm-status {
\r
583 enum NO_SOURCE_TC {
\r
584 description "TCM byte 3 (bits 6 7 8) -- 0 0 0, No source Tandem Connection";
\r
586 enum IN_USE_WITHOUT_IAE {
\r
587 description "TCM byte 3 (bits 6 7 8) -- 0 0 1, In use without IAE (Incoming Alignment Error)";
\r
589 enum IN_USE_WITH_IAE {
\r
590 description "TCM byte 3 (bits 6 7 8) -- 0 1 0, In use with IAE (Incoming Alignment Error)";
\r
593 description "TCM byte 3 (bits 6 7 8) -- 0 1 1, Reserved for future international standardization";
\r
596 description "TCM byte 3 (bits 6 7 8) -- 1 0 0, Reserved for future international standardization";
\r
599 description "TCM byte 3 (bits 6 7 8) -- 1 0 1, Maintenance signal: ODU-LCK";
\r
602 description "TCM byte 3 (bits 6 7 8) -- 1 1 0, Maintenance signal: ODU-OCI";
\r
605 description "TCM byte 3 (bits 6 7 8) -- 1 1 1, Maintenance signal: ODU-AIS";
\r
608 description "See Table 15-5/G.709/Y.1331 ";
\r
613 description "none";
\r
616 description "none";
\r
619 description "none";
\r
622 description "List of value modes for the sink side of the tandem connection monitoring function.";
\r
624 typedef tcm-monitoring {
\r
627 description "none";
\r
629 enum NON-INTRUSIVE {
\r
630 description "none";
\r
633 description "Monitoring types for the tandem connection monitoring function.";
\r
635 typedef tcm-extension {
\r
638 description "none";
\r
640 enum PASS-THROUGH {
\r
641 description "none";
\r
644 description "none";
\r
647 description "none";
\r
649 typedef percentage-granularity {
\r
652 description "none";
\r
655 description "value * (1/10)";
\r
657 enum ONE_HUNDREDTHS {
\r
658 description "value * (1/100)";
\r
660 enum ONE_THOUSANDTHS {
\r
661 description "value * (1/1000)";
\r
664 description "none";
\r
666 grouping uas-choice-g {
\r
667 leaf bidirectional {
\r
670 description "none";
\r
674 description "none";
\r
678 description "none";
\r
682 description "none";
\r
684 description "If bidirectional is TRUE then use the uas attribute, if bidirectional is FALSE use the nuas, and fuas attributes";
\r