2 namespace "urn:onf:otcc:yang:tapi-oam";
7 import tapi-connectivity {
8 prefix tapi-connectivity;
10 import tapi-topology {
13 organization "ONF OTCC (Open Transport Configuration & Control) Project";
15 Project Web: <https://wiki.opennetworking.org/display/OTCC/TAPI>
16 Project List: <mailto:transport-api@opennetworking.org>
17 Editor: Karthik Sethuraman
18 <mailto:karthik.sethuraman@necam.com>";
20 This module contains TAPI OAM Model definitions.
22 - The TAPI YANG models included in this TAPI release are a *normative* part of the TAPI SDK.
23 - The YANG specifications have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG mapping tool]
24 <https://github.com/OpenNetworkingFoundation/EagleUmlYang>
25 and further edited manually to comply with the [ONF IISOMI UML2YANG mapping guidelines]
26 <https://wiki.opennetworking.org/display/OIMT/UML+-+YANG+Guidelines>
27 - Status of YANG model artifacts can be determined by referring to the corresponding UML artifacts.
28 As described in the UML models, some artifacts are considered *experimental*, and thus the corresponding YANG artifacts.
29 - The ONF TAPI release process does not guarantee backward compatibility of YANG models across major versions of TAPI releases.
30 The YANG model backward compatibility criteria are outlined in section 11 of <https://tools.ietf.org/html/rfc7950>.
31 YANG models included in this release may not be backward compatible with previous TAPI releases.
32 Copyright (c) 2018 Open Networking Foundation (ONF). All rights reserved.
33 License: This module is distributed under the Apache License 2.0";
35 description "ONF Transport API version 2.1.1.
36 Changes included in this TAPI release (v2.1.1) are listed in
37 <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.1.md>";
38 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model
39 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";
42 description "ONF Transport API version 2.1.0.
43 Changes included in this TAPI release (v2.1.0) are listed in
44 <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.0.md>";
45 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model
46 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";
49 description "ONF Transport API version 2.0.2
50 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
51 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.2.md>";
52 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
53 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.2/UML>";
56 description "ONF Transport API version 2.0.1
57 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
58 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.1.md>";
59 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
60 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.1/UML>";
63 description "ONF Transport API version 2.0.0
64 This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.
65 Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.0.md>";
66 reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
67 <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.0/UML>";
69 augment "/tapi-common:context" {
70 container oam-context {
72 description "Augments the base TAPI Context with OamService information";
74 description "Augments the base TAPI Context with OamService information";
76 augment "/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:cep-list/tapi-connectivity:connection-end-point" {
77 container mep-mip-list {
84 /**************************
85 * definitions of references
86 **************************/
87 grouping oam-service-ref {
88 leaf oam-service-uuid {
90 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:uuid';
96 grouping oam-service-end-point-ref {
98 leaf oam-service-end-point-local-id {
100 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-service/tapi-oam:end-point/tapi-oam:local-id';
109 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:uuid';
115 grouping maintenance-entity-ref {
117 leaf maintenance-entity-local-id {
119 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id';
129 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mep/tapi-oam:local-id';
139 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:meg/tapi-oam:mip/tapi-oam:local-id';
145 grouping oam-job-ref {
148 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:uuid';
154 grouping pm-current-data-ref {
156 leaf pm-current-data-local-id {
158 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:pm-current-data/tapi-oam:local-id';
164 grouping pm-history-data-ref {
165 uses pm-current-data-ref;
166 leaf pm-history-data-local-id {
168 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-job/tapi-oam:pm-current-data/tapi-oam:pm-history-data/tapi-oam:local-id';
174 grouping oam-profile-ref {
175 leaf oam-profile-uuid {
177 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:uuid';
183 grouping pm-threshold-data-ref {
184 uses oam-profile-ref;
185 leaf pm-threshold-data-local-id {
187 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:pm-threshold-data/tapi-oam:local-id';
193 grouping pm-bin-data-ref {
194 uses oam-profile-ref;
195 leaf pm-bin-data-local-id {
197 path '/tapi-common:context/tapi-oam:oam-context/tapi-oam:oam-profile/tapi-oam:pm-bin-data/tapi-oam:local-id';
204 /**************************
205 * package object-classes
206 **************************/
208 leaf layer-protocol-name {
209 type tapi-common:layer-protocol-name;
214 type tapi-common:termination-direction;
218 leaf mep-identifier {
223 leaf-list peer-mep-identifier {
229 uses tapi-common:local-class;
230 uses tapi-common:operational-state-pac;
234 list oam-service-end-point {
235 uses oam-service-end-point-ref;
236 key 'oam-service-uuid oam-service-end-point-local-id';
240 container oam-profile {
241 uses oam-profile-ref;
244 list pm-current-data {
247 uses pm-current-data;
248 description "Granularity period of the CurrentData identifies the specific CurrentData instance in the scope of this OamJob.
249 For example, typically at least
252 optionally one additional configurable (< 15min)";
259 uses tapi-common:time-range;
263 type tapi-common:date-and-time;
267 uses tapi-common:global-class;
268 uses tapi-common:admin-state-pac;
276 description "1. ME may have 0 MEPs (case of transit domains where at least 1 MIP is present)
277 2. ME may have 1 MEP (case of edge domaind, where the peer MEP is ouside the managed domain)
278 3. ME may have 2 MEPs";
284 description "ME may 0, 1, or more MIPs";
286 leaf layer-protocol-name {
287 type tapi-common:layer-protocol-name;
292 type tapi-common:forwarding-direction;
301 leaf meg-identifier {
306 uses tapi-common:resource-spec;
307 uses tapi-common:operational-state-pac;
311 leaf layer-protocol-name {
312 type tapi-common:layer-protocol-name;
316 uses tapi-common:local-class;
319 grouping oam-service {
323 uses oam-service-end-point;
331 container oam-profile {
332 uses oam-profile-ref;
335 uses tapi-common:service-spec;
336 uses tapi-common:admin-state-pac;
340 grouping oam-context {
364 grouping oam-service-end-point {
365 container service-interface-point {
366 uses tapi-common:service-interface-point-ref;
369 container connectivity-service-end-point {
370 uses tapi-connectivity:connectivity-service-end-point-ref;
383 leaf layer-protocol-name {
384 type tapi-common:layer-protocol-name;
388 type tapi-common:port-direction;
391 leaf mep-identifier {
393 description "This attribute contains the identifier of the MEP.
394 This attribute is empty in case the OSEP relates to the provisioing of an MIP.
397 leaf-list peer-mep-identifier {
399 description "This attribute models the MI_PeerMEP_ID[i] defined in G.8021 and configured as specified in G.8051. It provides the identifiers of the MEPs which are peer to the subject MEP.
400 This attribute is not specified in case the OSEP relates to the provisioing of an MIP.
401 In case of P2P, there is only one peer";
403 uses tapi-common:local-class;
404 uses tapi-common:admin-state-pac;
407 grouping mep-mip-list {
410 key 'meg-uuid mip-local-id';
415 key 'meg-uuid mep-local-id';
420 grouping oam-constraint {
421 leaf layer-protocol-name {
422 type tapi-common:layer-protocol-name;
426 type tapi-common:forwarding-direction;
435 grouping pm-current-data {
436 list pm-history-data {
439 uses pm-history-data;
440 description "in case of 24hr Current Data, at least 1 History Data.
441 In case of 15min Current Data, at least 16 History Data.
442 In case of <15min, the number of History Data shall be able to cover a span of 4 hours.";
444 container granularity-period {
445 uses tapi-common:time-period;
449 type tapi-common:date-and-time;
451 description "This attribute indicates the start of the current monitoring interval.
452 The value is bound to the quarter of an hour in case of a 15 minute interval and bound to the hour in case of a 24 hour interval.";
454 container elapsed-time {
455 uses tapi-common:time-interval;
458 leaf suspect-interval-flag {
460 description "This attribute is used to indicate that the performance data for the current period may not be reliable. Some reasons for this to occur are:
461 – Suspect data were detected by the actual resource doing data collection.
462 – Transition of the administrativeState attribute to/from the 'lock' state.
463 – Transition of the operationalState to/from the 'disabled' state.
464 – Scheduler setting that inhibits the collection function.
465 – The performance counters were reset during the interval.
466 – The currentData (or subclass) object instance was created during the monitoring period.";
468 uses tapi-common:local-class;
471 grouping pm-history-data {
472 container granularity-period {
473 uses tapi-common:time-period;
476 leaf period-end-time {
477 type tapi-common:date-and-time;
480 leaf suspect-interval-flag {
483 description "This attribute indicates that the performance data may not be reliable.";
485 uses tapi-common:local-class;
488 grouping oam-profile {
489 list pm-threshold-data {
492 uses pm-threshold-data;
501 uses tapi-common:global-class;
504 grouping pm-threshold-data {
505 container granularity-period {
506 uses tapi-common:time-period;
513 uses tapi-common:local-class;
516 grouping pm-bin-data {
517 container granularity-period {
518 uses tapi-common:time-period;
521 uses tapi-common:local-class;
525 /**************************
526 * package type-definitions
527 **************************/
528 identity OAM_JOB_TYPE {
531 typedef oam-job-type {
538 /**************************
540 **************************/
541 rpc create-oam-service {
547 uses oam-service-end-point;
550 container oam-constraint {
566 rpc delete-oam-service {
575 rpc get-oam-service {
597 list oam-service-end-point {
600 uses oam-service-end-point;
603 container oam-profile {
638 rpc get-oam-service-list {
663 rpc update-oam-service {
672 uses oam-service-end-point;
675 container oam-constraint {
707 container oam-profile {
727 rpc create-oam-service-end-point {
754 leaf mep-identifier {
758 leaf-list peer-mep-identifier {
764 container end-point {
765 uses oam-service-end-point;
770 rpc delete-oam-service-end-point {
783 rpc update-oam-service-end-point {
800 container end-point {
801 uses oam-service-end-point;
806 rpc get-oam-service-end-point {
819 container end-point {
820 uses oam-service-end-point;