f5967610693da0cd1828175baed8dd813481a257
[transportpce.git] / ordmodels / device / src / main / yang / org-openroadm-physical-types@2017-12-15.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-types {
6     prefix org-openroadm-common-types;
7     revision-date 2017-12-15;
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      AT&T Intellectual Property.  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 2017-12-15 {
48     description
49       "Version 2.2";
50   }
51   revision 2017-09-29 {
52     description
53       "Version 2.1";
54   }
55   revision 2017-07-28 {
56     description
57       "Version 2.0.1 - added revision-date to imports";
58   }
59   revision 2017-06-26 {
60     description
61       "Version 2.0";
62   }
63   revision 2016-10-14 {
64     description
65       "Version 1.2";
66   }
67
68   grouping node-info {
69     description
70       "Physical inventory data used by the node";
71     leaf vendor {
72       type string;
73       config false;
74       mandatory true;
75       description
76         "Vendor of the equipment";
77     }
78     leaf model {
79       type string;
80       config false;
81       mandatory true;
82       description
83         "Physical resource model information.";
84     }
85     leaf serial-id {
86       type string;
87       config false;
88       mandatory true;
89       description
90         "Product Code for this physical resource";
91     }
92   }
93
94   grouping common-info {
95     description
96       "Physical inventory data used by all other entities";
97     uses node-info;
98     leaf type {
99       type string;
100       config false;
101       description
102         "The specific type of this physical resource - ie the type of
103          shelf, type of circuit-pack, etc.";
104     }
105     leaf product-code {
106       type string;
107       config false;
108       description
109         "Product Code for this physical resource";
110     }
111     leaf manufacture-date {
112       type yang:date-and-time;
113       config false;
114       description
115         "Manufacture date of physical resource";
116     }
117     leaf clei {
118       type string;
119       config false;
120       description
121         "CLEI for this physical resource";
122     }
123     leaf hardware-version {
124       type string;
125       config false;
126       description
127         "The version of the hardware.";
128     }
129     leaf operational-state {
130       type org-openroadm-common-types:state;
131       config false;
132       description
133         "Operational state of the physical resource";
134     }
135   }
136 }