0fdcdb6056f01957c2f913401c527d4c5539f933
[transportpce.git] / ordmodels / device / src / main / yang / org-openroadm-swdl@2016-10-14.yang
1 module org-openroadm-swdl {
2   namespace "http://org/openroadm/de/swdl";
3   prefix org-openroadm-swdl;
4
5   import ietf-yang-types {
6     prefix yang;
7   }
8
9   import org-openroadm-common-types {
10     prefix org-openroadm-common-types;
11   }
12
13   organization "Open ROADM MSA";
14   contact
15     "OpenROADM.org";
16   description
17     "Yang definitions for System Management.
18
19      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
20      AT&T Intellectual Property.  All other rights reserved.
21
22      Redistribution and use in source and binary forms, with or without modification,
23      are permitted provided that the following conditions are met:
24
25      * Redistributions of source code must retain the above copyright notice, this
26        list of conditions and the following disclaimer.
27      * Redistributions in binary form must reproduce the above copyright notice,
28        this list of conditions and the following disclaimer in the documentation and/or
29        other materials provided with the distribution.
30      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
31        contributors may be used to endorse or promote products derived from this software
32        without specific prior written permission.
33
34      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
35      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
36      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
37      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
38      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
40      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
41      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43      POSSIBILITY OF SUCH DAMAGE.";
44
45   revision 2016-10-14 {
46     description
47       "Version 1.2";
48   }
49
50   grouping sw-bank {
51     leaf sw-version {
52       type string;
53       description
54         "Gissue of the SW in this bank";
55     }
56     leaf sw-validation-timer {
57       type string {
58         pattern "(([0-1][0-9]|2[0-3])-([0-5][0-9])-([0-5][0-9]))";
59       }
60       description
61         "value of validation timer in hh-mm-ss";
62     }
63     leaf activation-date-time {
64       type yang:date-and-time;
65       description
66         "activation date and time: The date load was activated";
67     }
68   }
69
70   rpc sw-stage {
71     description
72       "SW stage - copies the SW from repo to staging bank";
73     input {
74       leaf filename {
75         type string {
76           length "10..255";
77         }
78         description
79           "file name which has the load";
80       }
81     }
82     output {
83       uses org-openroadm-common-types:rpc-response-status;
84     }
85   }
86   rpc sw-activate {
87     description
88       "Activate new load";
89     input {
90       leaf version {
91         type string;
92         description
93           " software version of the new load which is being activated";
94       }
95       leaf validationTimer {
96         type string;
97         description
98           "validation timer hh-mm-ss";
99       }
100     }
101     output {
102       uses org-openroadm-common-types:rpc-response-status;
103     }
104   }
105   rpc cancel-validation-timer {
106     description
107       "Cancel validation timer which user provisioned as part of activate command";
108     input {
109       leaf accept {
110         type boolean;
111         default "true";
112         description
113           " TRUE means  validation timer is cancelled and new load is accepted";
114       }
115     }
116     output {
117       uses org-openroadm-common-types:rpc-response-status;
118     }
119   }
120 }