Sync Common folder
[transportpce.git] / ordmodels / common / src / main / yang / org-openroadm-maintenance@2017-12-15.yang
1 module org-openroadm-maintenance {
2   namespace "http://org/openroadm/maintenance";
3   prefix org-openroadm-mainteance;
4
5   import org-openroadm-resource {
6     prefix org-openroadm-resource;
7     revision-date 2017-12-15;
8   }
9
10   organization
11     "Open ROADM MSA";
12   contact
13     "OpenROADM.org";
14   description
15     "YANG definitions of maintenace operations.
16        
17       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016, 
18       AT&T Intellectual Property.  All other rights reserved.
19       
20       Redistribution and use in source and binary forms, with or without modification, 
21       are permitted provided that the following conditions are met:
22       
23       * Redistributions of source code must retain the above copyright notice, this 
24         list of conditions and the following disclaimer.
25       * Redistributions in binary form must reproduce the above copyright notice, 
26         this list of conditions and the following disclaimer in the documentation and/or 
27         other materials provided with the distribution.
28       * Neither the Members of the Open ROADM MSA Agreement nor the names of its 
29         contributors may be used to endorse or promote products derived from this software 
30         without specific prior written permission.
31       
32       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS'' 
33       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
34       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
35       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT, 
36       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
37       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA, 
38       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
39       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
40       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
41       POSSIBILITY OF SUCH DAMAGE";
42
43   revision 2017-12-15 {
44     description
45       "Version 2.2";
46   }
47   revision 2017-09-29 {
48     description
49       "Version 2.1";
50   }
51   revision 2017-07-28 {
52     description
53       "Version 2.0.1 - added revision-date to imports";
54   }
55   revision 2016-10-14 {
56     description
57       "Version 1.2";
58   }
59
60   typedef maintenance-operation {
61     type enumeration {
62       enum "terminalLoopback" {
63         value 1;
64       }
65       enum "facilityLoopback" {
66         value 2;
67       }
68       enum "testSignal" {
69         value 3;
70       }
71     }
72     description
73       "Maintenance Operation.";
74   }
75
76   grouping maintenance {
77     leaf id {
78       type string;
79       mandatory true;
80       description
81         "Uniquely identify maintenance activity";
82     }
83     container resource {
84       description
85         "Resource under maintenance";
86       uses org-openroadm-resource:resource;
87     }
88     leaf operation {
89       type maintenance-operation;
90     }
91   }
92
93   container maintenance-list {
94     description
95       "A list of active maintenance operations. Adding an entry to this list creates an active maintenance operation.  Removing an entry from this terminates a maintenance activity";
96     list maintenance {
97       key "id";
98       uses maintenance;
99     }
100   }
101 }