Sync Common folder
[transportpce.git] / api / src / main / yang / transportpce-portmapping@2017-02-28.yang
1 module transportpce-portmapping {
2   yang-version 1;
3   namespace "http://org/opendaylight/transportpce/portmapping";
4   prefix "org-opendaylight-transportpce-portmapping";
5
6   import org-openroadm-common-types {
7     prefix org-openroadm-common-types;
8     revision-date 2016-10-14;
9   }
10
11  organization
12     "transportPCE";
13   contact
14     "transportPCE committers - ODL";
15   description
16     "YANG definitions of RPCs supported by OLM.
17      Copyright (c) 2017 AT&T and others.  All rights reserved.
18      authors: Dhruv Bhardwaj ( db929a@att.com )
19               Shweta Vachhani ( sv111y@att.com )";
20
21   revision "2017-02-28" {
22     description "Initial revision of port mapping model";
23   }
24   container network{
25     list nodes{
26       key node-id;
27       leaf node-id{
28         type string;
29         description
30           "Unique identifier for node in the network";
31       }
32
33       leaf openroadm-version{
34         type enumeration {
35           enum "1.2.1" {
36             value 1;
37             description
38               "Version 1.2.1";
39             }
40             enum "2.2" {
41               value 2;
42               description
43                 "Version 2.2";
44             }
45           }
46         }
47       leaf node-type{
48         type org-openroadm-common-types:node-types;
49         description
50           "Identifier for node-type e.g Roadm, xponder";
51       }
52       list mapping{
53         description
54           "Mapping for Physical circuit pack/port/parent interfaces
55           corresponding to each logical connection point present in the node.";
56         key logical-connection-point;
57         leaf logical-connection-point{
58           type string;
59         }
60         leaf supporting-circuit-pack-name{
61           type string;
62           description
63           "Circuit pack where the logical connection point is located";
64         }
65         leaf supporting-port{
66           type string;
67           description
68           "Port where the logical connection point is located";
69         }
70         leaf supporting-oms{
71           type string;
72           description
73           "OMS interface provisioned on the port";
74         }
75         leaf supporting-ots{
76           type string;
77           description
78           "OTS interface provisioned on the port";
79         }
80       }
81       list cp-to-degree{
82         description
83           "This mapping helps locate degree number of the circuitpack that does lldp
84          protocol management";
85        key circuit-pack-name;
86        leaf circuit-pack-name{
87           type string;
88        }
89        leaf degree-number{
90             type uint32;
91        }
92        leaf interface-name{
93           type string;
94        }
95       }
96     }
97   }
98 }