Add TAPI Topology simulated network function type.
[sim/o1-interface.git] / ntsimulator / deploy / smo-nts-ng-topology-server / yang / tapi-virtual-network@2020-06-16.yang
diff --git a/ntsimulator/deploy/smo-nts-ng-topology-server/yang/tapi-virtual-network@2020-06-16.yang b/ntsimulator/deploy/smo-nts-ng-topology-server/yang/tapi-virtual-network@2020-06-16.yang
new file mode 100644 (file)
index 0000000..978b05c
--- /dev/null
@@ -0,0 +1,289 @@
+module tapi-virtual-network {\r
+    namespace "urn:onf:otcc:yang:tapi-virtual-network";\r
+    prefix tapi-virtual-network;\r
+    import tapi-topology {\r
+        prefix tapi-topology;\r
+    }\r
+    import tapi-common {\r
+        prefix tapi-common;\r
+    }\r
+    organization "ONF OTCC (Open Transport Configuration & Control) Project";\r
+    contact "\r
+         Project Web: <https://wiki.opennetworking.org/display/OTCC/TAPI>\r
+         Project List: <mailto:transport-api@opennetworking.org>\r
+         Editor: Karthik Sethuraman <mailto:karthik.sethuraman@necam.com>\r
+         Andrea Mazzini <mailto:andrea.mazzini@nokia.com>\r
+         Arturo Mayoral <mailto:arturo.mayoral@telefonica.com>\r
+         Nigel Davis <mailto:ndavis@ciena.com>";\r
+    description "\r
+        This module contains TAPI Virtual Network Model definitions.\r
+        Source: TapiVirtualNetwork.uml\r
+        - The TAPI YANG models included in this TAPI release are a *normative* part of the TAPI SDK.\r
+        - The YANG specifications have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG mapping tool]\r
+        <https://github.com/OpenNetworkingFoundation/EagleUmlYang>\r
+        and further edited manually to comply with the [ONF IISOMI UML2YANG mapping guidelines]\r
+        <https://wiki.opennetworking.org/display/OIMT/UML+-+YANG+Guidelines>\r
+        - Status of YANG model artifacts can be determined by referring to the corresponding UML artifacts.\r
+        As described in the UML models, some artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r
+        - The ONF TAPI release process does not guarantee backward compatibility of YANG models across major versions of TAPI releases.\r
+        The YANG model backward compatibility criteria are outlined in section 11 of <https://tools.ietf.org/html/rfc7950>.\r
+        YANG models included in this release may not be backward compatible with previous TAPI releases.\r
+        Copyright (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r
+        License: This module is distributed under the Apache License 2.0.";\r
+    revision 2020-06-16 {\r
+        description "ONF Transport API version 2.1.3.\r
+                   - schedule type changed to tapi-common:time-range.\r
+                   Changes included in this TAPI release (v2.1.3) are listed in\r
+                   <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop_v2_1/CHANGE_LOG/change-log.2.1.3.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";\r
+    }\r
+    revision 2019-07-16 {\r
+        description "ONF Transport API version 2.1.2.\r
+                   Changes included in this TAPI release (v2.1.2) are listed in\r
+                   <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop_v2_1/CHANGE_LOG/change-log.2.1.2.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";\r
+    }\r
+    revision 2018-12-10 {\r
+        description "ONF Transport API version 2.1.1.\r
+                   Changes included in this TAPI release (v2.1.1) are listed in\r
+                   <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.1.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";\r
+    }\r
+    revision 2018-10-16 {\r
+        description "ONF Transport API version 2.1.0.\r
+                   Changes included in this TAPI release (v2.1.0) are listed in\r
+                   <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.0.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML>";\r
+    }\r
+    revision 2018-03-07 {\r
+        description "ONF Transport API version 2.0.2\r
+        This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+        Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.2.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.2/UML>";\r
+    }\r
+    revision 2018-02-16 {\r
+        description "ONF Transport API version 2.0.1\r
+        This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+        Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.1.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.1/UML>";\r
+    }\r
+    revision 2018-01-02 {\r
+        description "ONF Transport API version 2.0.0\r
+        This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+        Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.0.md>";\r
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.0/UML>";\r
+    }\r
+    augment "/tapi-common:context" {\r
+        container virtual-network-context {\r
+            uses virtual-network-context;\r
+            description "Augments the base TAPI Context with VirtualNetworkService information";\r
+        }\r
+        description "Augments the base TAPI Context with VirtualNetworkService information";\r
+    }\r
+   /**************************\r
+    * definitions of references\r
+    **************************/\r
+    grouping virtual-nw-service-ref {\r
+        leaf virtual-nw-service-uuid {\r
+            type leafref {\r
+                path '/tapi-common:context/tapi-virtual-network:virtual-network-context/tapi-virtual-network:virtual-nw-service/tapi-virtual-network:uuid';\r
+            }\r
+            description "none";\r
+        }\r
+        description "none";\r
+    }\r
+\r
+   /**************************\r
+    * package object-classes\r
+    **************************/ \r
+    grouping virtual-network-constraint {\r
+        container src-service-end-point {\r
+            uses tapi-common:service-interface-point-ref;\r
+            config false;\r
+            description "none";\r
+        }\r
+        container sink-service-end-point {\r
+            uses tapi-common:service-interface-point-ref;\r
+            config false;\r
+            description "none";\r
+        }\r
+        list diversity-exclusion {\r
+            uses virtual-nw-service-ref;\r
+            key 'virtual-nw-service-uuid';\r
+            config false;\r
+            description "none";\r
+        }\r
+        container requested-capacity {\r
+            uses tapi-common:capacity;\r
+            description "none";\r
+        }\r
+        leaf service-level {\r
+            type string;\r
+            description "An abstract value the meaning of which is mutually agreed – typically represents metrics such as - Class of service, priority, resiliency, availability";\r
+        }\r
+        leaf-list service-layer {\r
+            type tapi-common:layer-protocol-name;\r
+            description "none";\r
+        }\r
+        list cost-characteristic {\r
+            key 'cost-name';\r
+            uses tapi-topology:cost-characteristic;\r
+            description "The list of costs where each cost relates to some aspect of the TopologicalEntity.";\r
+        }\r
+        list latency-characteristic {\r
+            key 'traffic-property-name';\r
+            uses tapi-topology:latency-characteristic;\r
+            description "The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.";\r
+        }\r
+        uses tapi-common:local-class;\r
+        description "none";\r
+    }\r
+    grouping virtual-network-service {\r
+        container topology {\r
+            uses tapi-topology:topology-ref;\r
+            config false;\r
+            description "none";\r
+        }\r
+        list end-point {\r
+            key 'local-id';\r
+            min-elements 2;\r
+            uses virtual-network-service-end-point;\r
+            description "none";\r
+        }\r
+        list vnw-constraint {\r
+            key 'local-id';\r
+            min-elements 1;\r
+            uses virtual-network-constraint;\r
+            description "none";\r
+        }\r
+        container schedule {\r
+            uses tapi-common:time-range;\r
+            description "none";\r
+        }\r
+        container state {\r
+            uses tapi-common:admin-state-pac;\r
+            description "none";\r
+        }\r
+        leaf-list layer-protocol-name {\r
+            type tapi-common:layer-protocol-name;\r
+            min-elements 1;\r
+            description "none";\r
+        }\r
+        uses tapi-common:service-spec;\r
+        description "The ForwardingConstruct (FC) object class models enabled potential for forwarding between two or more LTPs and like the LTP supports any transport protocol including all circuit and packet forms.\r
+            At the lowest level of recursion, a FC represents a cross-connection within an NE.";\r
+    }\r
+    grouping virtual-network-service-end-point {\r
+        container service-interface-point {\r
+            uses tapi-common:service-interface-point-ref;\r
+            config false;\r
+            description "none";\r
+        }\r
+        leaf role {\r
+            type tapi-common:port-role;\r
+            config false;\r
+            description "Each EP of the FC has a role (e.g., working, protection, protected, symmetric, hub, spoke, leaf, root)  in the context of the FC with respect to the FC function. ";\r
+        }\r
+        leaf direction {\r
+            type tapi-common:port-direction;\r
+            config false;\r
+            description "The orientation of defined flow at the EndPoint.";\r
+        }\r
+        leaf service-layer {\r
+            type tapi-common:layer-protocol-name;\r
+            config false;\r
+            description "none";\r
+        }\r
+        uses tapi-common:local-class;\r
+        description "The association of the FC to LTPs is made via EndPoints.\r
+            The EndPoint (EP) object class models the access to the FC function. \r
+            The traffic forwarding between the associated EPs of the FC depends upon the type of FC and may be associated with FcSwitch object instances.  \r
+            In cases where there is resilience the EndPoint may convey the resilience role of the access to the FC. \r
+            It can represent a protected (resilient/reliable) point or a protecting (unreliable working or protection) point.\r
+            The EP replaces the Protection Unit of a traditional protection model. \r
+            The ForwadingConstruct can be considered as a component and the EndPoint as a Port on that component";\r
+    }\r
+    grouping virtual-network-context {\r
+        list virtual-nw-service {\r
+            key 'uuid';\r
+            uses virtual-network-service;\r
+            description "none";\r
+        }\r
+        description "none";\r
+    }\r
+\r
+    /**************************\r
+    * package interfaces\r
+    **************************/ \r
+    rpc create-virtual-network-service {\r
+        description "none";\r
+        input {\r
+            list sep {\r
+                min-elements 2;\r
+                uses virtual-network-service-end-point;\r
+                description "none";\r
+            }\r
+            container vnw-constraint {\r
+                uses virtual-network-constraint;\r
+                description "none";\r
+            }\r
+            container conn-schedule {\r
+                uses tapi-common:time-range;\r
+                description "none";\r
+            }\r
+        }\r
+        output {\r
+            container service {\r
+                uses virtual-network-service;\r
+                description "none";\r
+            }\r
+        }\r
+    }\r
+    rpc delete-virtual-network-service {\r
+        description "none";\r
+        input {\r
+            leaf service-id-or-name {\r
+                type string;\r
+                description "none";\r
+            }\r
+        }\r
+        output {\r
+            container service {\r
+                uses virtual-network-service;\r
+                description "none";\r
+            }\r
+        }\r
+    }\r
+    rpc get-virtual-network-service-details {\r
+        description "none";\r
+        input {\r
+            leaf service-id-or-name {\r
+                type string;\r
+                description "none";\r
+            }\r
+        }\r
+        output {\r
+            container service {\r
+                uses virtual-network-service;\r
+                description "none";\r
+            }\r
+        }\r
+    }\r
+    rpc get-virtual-network-service-list {\r
+        description "none";\r
+        output {\r
+            list service {\r
+                uses virtual-network-service;\r
+                description "none";\r
+            }\r
+        }\r
+    }\r
+\r
+}\r