Migrate to 171221 revision of MEF NRP API
[unimgr.git] / nrp-api / src / main / yang / tapi-common.yang
index 4158b3563d7fc0a9a0bfa8450056e5ec3cb35752..846228fed777547079d3d31031e96a944d7d1a16 100644 (file)
@@ -1,16 +1,19 @@
 module tapi-common {
-    namespace "urn:mef:yang:tapi-common";
+    namespace "urn:onf:params:xml:ns:yang:tapi-common";
     prefix tapi-common;
-    organization "Metro Ethernet Forum (MEF)";
-    contact "MEF";
+    organization "ONF (Open Networking Foundation) IMP Working Group";
+    contact "WG Web: <https://www.open{[]}networking.org/technical-communities/areas/services/> 
+ WG List: mailto: <wg list name>@opennetworking.org>, 
+.WG Chair: your-WG-chair<mailto:your-WG-chair@example.com> 
+Editor: your-name<mailto:your-email@example.com>";
     description "none";
-    revision 2017-07-12 {
-        description "MEF NRP 1.0.cfc4";
+    revision 2017-11-13 {
+        description "TAPI SDK 2.0-alpha";
         reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020 and RFC 6087";
     }
     /***********************
     * package object-classes
-    **********************/
+    **********************/ 
         grouping admin-state-pac {
             leaf administrative-state {
                 type administrative-state;
@@ -104,6 +107,7 @@ module tapi-common {
         grouping context-attrs {
             list service-interface-point {
                 key 'uuid';
+                
                 uses service-interface-point;
                 description "none";
             }
@@ -158,51 +162,51 @@ module tapi-common {
 
     /***********************
     * package type-definitions
-    **********************/
+    **********************/ 
         identity layer-protocol-name {
             description "none";
         }
-        identity och {
+        identity OCH {
             base layer-protocol-name;
             description "none";
         }
-        identity odu {
+        identity ODU {
             base layer-protocol-name;
             description "none";
         }
-        identity eth {
+        identity ETH {
             base layer-protocol-name;
             description "none";
         }
-        identity mpls-tp {
+        identity MPLS_TP {
             base layer-protocol-name;
             description "none";
         }
         identity capacity-unit {
             description "none";
         }
-        identity gbps {
+        identity GBPS {
             base capacity-unit;
             description "none";
         }
-        identity kbps {
+        identity KBPS {
             base capacity-unit;
             description "none";
         }
-        identity mbps {
+        identity MBPS {
             base capacity-unit;
             description "none";
         }
-        identity not-applicable {
+        identity NOT_APPLICABLE {
             base capacity-unit;
             description "none";
         }
         typedef administrative-state {
             type enumeration {
-                enum locked {
+                enum LOCKED {
                     description "Users are administratively prohibited from making use of the resource.";
                 }
-                enum unlocked {
+                enum UNLOCKED {
                     description "Users are allowed to use the resource";
                 }
             }
@@ -226,19 +230,19 @@ module tapi-common {
         }
         typedef directive-value {
             type enumeration {
-                enum minimize {
+                enum MINIMIZE {
                     description "none";
                 }
-                enum maximize {
+                enum MAXIMIZE {
                     description "none";
                 }
-                enum allow {
+                enum ALLOW {
                     description "none";
                 }
-                enum disallow {
+                enum DISALLOW {
                     description "none";
                 }
-                enum dont-care {
+                enum DONT_CARE {
                     description "none";
                 }
             }
@@ -246,13 +250,13 @@ module tapi-common {
         }
         typedef forwarding-direction {
             type enumeration {
-                enum bidirectional {
+                enum BIDIRECTIONAL {
                     description "The Fowarding entity supports both BIDIRECTIONAL flows at all Ports (i.e. all Ports have both an INPUT flow and an OUTPUT flow defined)";
                 }
-                enum unidirectional {
+                enum UNIDIRECTIONAL {
                     description "The Forwarding entity has Ports that are either INPUT or OUTPUT. It has no BIDIRECTIONAL Ports.";
                 }
-                enum undefined-or-unknown {
+                enum UNDEFINED_OR_UNKNOWN {
                     description "Not a normal state. The system is unable to determine the correct value.";
                 }
             }
@@ -271,18 +275,18 @@ module tapi-common {
         }
         typedef lifecycle-state {
             type enumeration {
-                enum planned {
+                enum PLANNED {
                     description "The resource is planned but is not present in the network.";
                 }
-                enum potential {
+                enum POTENTIAL {
                     description "The supporting resources are present in the network but are shared with other clients; or require further configuration before they can be used; or both.
                         o    When a potential resource is configured and allocated to a client it is moved to the “installed” state for that client.
                         o    If the potential resource has been consumed (e.g. allocated to another client) it is moved to the “planned” state for all other clients.";
                 }
-                enum installed {
+                enum INSTALLED {
                     description "The resource is present in the network and is capable of providing the service expected.";
                 }
-                enum pending-removal {
+                enum PENDING_REMOVAL {
                     description "The resource has been marked for removal";
                 }
             }
@@ -301,10 +305,10 @@ module tapi-common {
         }
         typedef operational-state {
             type enumeration {
-                enum disabled {
+                enum DISABLED {
                     description "The resource is unable to meet the SLA of the user of the resource. If no (explicit) SLA is defined the resource is disabled if it is totally inoperable and unable to provide service to the user.";
                 }
-                enum enabled {
+                enum ENABLED {
                     description "The resource is partially or fully operable and available for use";
                 }
             }
@@ -312,16 +316,16 @@ module tapi-common {
         }
         typedef port-direction {
             type enumeration {
-                enum bidirectional {
+                enum BIDIRECTIONAL {
                     description "The Port has both an INPUT flow and an OUTPUT flow defined.";
                 }
-                enum input {
+                enum INPUT {
                     description "The Port only has definition for a flow into the Forwarding entity (i.e. an ingress flow).";
                 }
-                enum output {
+                enum OUTPUT {
                     description "The Port only has definition for a flow out of the Forwarding entity (i.e. an egress flow).";
                 }
-                enum unidentified-or-unknown {
+                enum UNIDENTIFIED_OR_UNKNOWN {
                     description "Not a normal state. The system is unable to determine the correct value.";
                 }
             }
@@ -329,19 +333,19 @@ module tapi-common {
         }
         typedef port-role {
             type enumeration {
-                enum symmetric {
+                enum SYMMETRIC {
                     description "none";
                 }
-                enum root {
+                enum ROOT {
                     description "none";
                 }
-                enum leaf {
+                enum LEAF {
                     description "none";
                 }
-                enum trunk {
+                enum TRUNK {
                     description "none";
                 }
-                enum unknown {
+                enum UNKNOWN {
                     description "none";
                 }
             }
@@ -349,10 +353,10 @@ module tapi-common {
         }
         typedef termination-direction {
             type enumeration {
-                enum bidirectional {
+                enum BIDIRECTIONAL {
                     description "A Termination with both SINK and SOURCE flows.";
                 }
-                enum sink {
+                enum SINK {
                     description "The flow is up the layer stack from the server side to the client side. 
                         Considering an example of a Termination function within the termination entity, a SINK flow:
                         - will arrive at at the base of the termination function (the server side) where it is essentially at an INPUT to the termination component
@@ -361,7 +365,7 @@ module tapi-common {
                         A SINK termination is one that only supports a SINK flow.
                         A SINK termiation can be bound to an OUTPUT Port of a Forwarding entity";
                 }
-                enum source {
+                enum SOURCE {
                     description "The flow is down the layer stack from the server side to the client side. 
                         Considering an example of a Termination function within the termination entity, a SOURCE flow:
                         - will arrive at at the top of the termination function (the client side) where it is essentially at an INPUT to the termination component
@@ -370,7 +374,7 @@ module tapi-common {
                         A SOURCE termination is one that only supports a SOURCE flow.
                         A SOURCE termiation can be bound to an INPUT Port of a Forwarding entity";
                 }
-                enum undefined-or-unknown {
+                enum UNDEFINED_OR_UNKNOWN {
                     description "Not a normal state. The system is unable to determine the correct value.";
                 }
             }
@@ -378,25 +382,25 @@ module tapi-common {
         }
         typedef termination-state {
             type enumeration {
-                enum lp-can-never-terminate {
+                enum LP_CAN_NEVER_TERMINATE {
                     description "A non-flexible case that can never be terminated.";
                 }
-                enum lt-not-terminated {
+                enum LT_NOT_TERMINATED {
                     description "A flexible termination that can terminate but is currently not terminated.";
                 }
-                enum terminated-server-to-client-flow {
+                enum TERMINATED_SERVER_TO_CLIENT_FLOW {
                     description "A flexible termination that is currently terminated for server to client flow only.";
                 }
-                enum terminated-client-to-server-flow {
+                enum TERMINATED_CLIENT_TO_SERVER_FLOW {
                     description "A flexible termination that is currently terminated for client to server flow only.";
                 }
-                enum terminated-bidirectional {
+                enum TERMINATED_BIDIRECTIONAL {
                     description "A flexible termination that is currently terminated in both directions of flow.";
                 }
-                enum lt-permenantly-terminated {
+                enum LT_PERMENANTLY_TERMINATED {
                     description "A non-flexible termination that is always terminated (in both directions of flow for a bidirectional case and in the one direction of flow for both unidirectional cases).";
                 }
-                enum termination-state-unknown {
+                enum TERMINATION_STATE_UNKNOWN {
                     description "There TerminationState cannot be determined.";
                 }
             }
@@ -471,19 +475,19 @@ module tapi-common {
         }
         typedef bandwidth-profile-type {
             type enumeration {
-                enum not-applicable {
+                enum NOT_APPLICABLE {
                     description "none";
                 }
-                enum mef-10.x {
+                enum MEF_10.x {
                     description "none";
                 }
-                enum rfc-2697 {
+                enum RFC_2697 {
                     description "none";
                 }
-                enum rfc-2698 {
+                enum RFC_2698 {
                     description "none";
                 }
-                enum rfc-4115 {
+                enum RFC_4115 {
                     description "none";
                 }
             }
@@ -503,7 +507,7 @@ module tapi-common {
 
     /***********************
     * package interfaces
-    **********************/
+    **********************/ 
         rpc get-service-interface-point-details {
             description "none";
             input {