Update docs conf.yaml version to Sulfur
[transportpce.git] / ordmodels / device / src / main / yang / org-openroadm-physical-types@2019-11-29.yang
1 module org-openroadm-physical-types {
2   namespace "http://org/openroadm/physical/types";
3   prefix org-openroadm-physical-types;
4
5   import org-openroadm-common-state-types {
6     prefix org-openroadm-common-state-types;
7     revision-date 2019-11-29;
8   }
9   import ietf-yang-types {
10     prefix yang;
11     revision-date 2013-07-15;
12   }
13
14   organization
15     "Open ROADM MSA";
16   contact
17     "OpenROADM.org";
18   description
19     "YANG definitions of physical types.
20
21      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
22      All other rights reserved.
23
24      Redistribution and use in source and binary forms, with or without modification,
25      are permitted provided that the following conditions are met:
26
27      * Redistributions of source code must retain the above copyright notice, this
28        list of conditions and the following disclaimer.
29      * Redistributions in binary form must reproduce the above copyright notice,
30        this list of conditions and the following disclaimer in the documentation and/or
31        other materials provided with the distribution.
32      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
33        contributors may be used to endorse or promote products derived from this software
34        without specific prior written permission.
35
36      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
37      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
38      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
39      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
40      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
42      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
43      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
45      POSSIBILITY OF SUCH DAMAGE.";
46
47   revision 2019-11-29 {
48     description
49       "Version 6.1.0";
50   }
51   revision 2018-11-30 {
52     description
53       "Version 4.1.0";
54   }
55   revision 2018-09-28 {
56     description
57       "Version 4.0.0";
58   }
59   revision 2018-03-30 {
60     description
61       "Version 3.0.0";
62   }
63   revision 2017-12-15 {
64     description
65       "Version 2.2";
66   }
67   revision 2017-09-29 {
68     description
69       "Version 2.1";
70   }
71   revision 2017-07-28 {
72     description
73       "Version 2.0.1 - added revision-date to imports";
74   }
75   revision 2017-06-26 {
76     description
77       "Version 2.0";
78   }
79   revision 2016-10-14 {
80     description
81       "Version 1.2";
82   }
83
84   grouping node-info {
85     description
86       "Physical inventory data used by the node";
87     leaf vendor {
88       type string;
89       config false;
90       mandatory true;
91       description
92         "Vendor of the equipment";
93     }
94     leaf model {
95       type string;
96       config false;
97       mandatory true;
98       description
99         "Physical resource model information.";
100     }
101     leaf serial-id {
102       type string;
103       config false;
104       mandatory true;
105       description
106         "Product Code for this physical resource";
107     }
108   }
109
110   grouping common-info {
111     description
112       "Physical inventory data used by all other entities";
113     uses node-info;
114     leaf type {
115       type string;
116       config false;
117       description
118         "The specific type of this physical resource - ie the type of
119          shelf, type of circuit-pack, etc.";
120     }
121     leaf product-code {
122       type string;
123       config false;
124       description
125         "Product Code for this physical resource";
126     }
127     leaf manufacture-date {
128       type yang:date-and-time;
129       config false;
130       description
131         "Manufacture date of physical resource";
132     }
133     leaf clei {
134       type string;
135       config false;
136       description
137         "CLEI for this physical resource";
138     }
139     leaf hardware-version {
140       type string;
141       config false;
142       description
143         "The version of the hardware.";
144     }
145     leaf operational-state {
146       type org-openroadm-common-state-types:state;
147       config false;
148       mandatory true;
149       description
150         "Operational state of the physical resource";
151     }
152   }
153 }