Update docs conf.yaml version to Sulfur
[transportpce.git] / ordmodels / device / src / main / yang / org-openroadm-device-types@2019-11-29.yang
1 module org-openroadm-device-types {
2   namespace "http://org/openroadm/device-types";
3   prefix org-openroadm-device-types;
4
5   organization
6     "Open ROADM MSA";
7   contact
8     "OpenROADM.org";
9   description
10     "YANG definitions of device types.
11
12       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
13       All other rights reserved.
14
15       Redistribution and use in source and binary forms, with or without modification,
16       are permitted provided that the following conditions are met:
17
18       * Redistributions of source code must retain the above copyright notice, this
19         list of conditions and the following disclaimer.
20       * Redistributions in binary form must reproduce the above copyright notice,
21         this list of conditions and the following disclaimer in the documentation and/or
22         other materials provided with the distribution.
23       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
24         contributors may be used to endorse or promote products derived from this software
25         without specific prior written permission.
26
27       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
28       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
31       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
33       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
34       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36       POSSIBILITY OF SUCH DAMAGE";
37
38   revision 2019-11-29 {
39     description
40       "Version 6.1.0";
41   }
42   revision 2018-11-30 {
43     description
44       "Version 4.1.0";
45   }
46   revision 2018-03-30 {
47     description
48       "Version 3.0.0";
49   }
50
51   typedef node-types {
52     type enumeration {
53       enum rdm {
54         value 1;
55       }
56       enum xpdr {
57         value 2;
58       }
59       enum ila {
60         value 3;
61       }
62       enum extplug {
63         value 4;
64       }
65     }
66     description
67       "Identifier for node type
68        1. rdm for ROADM
69        2. xpdr for Transponder, Regen
70        3. ila for in-line amplifier
71        4. extplug for external pluggable";
72   }
73
74   typedef xpdr-node-types {
75     type enumeration {
76       enum tpdr {
77         value 1;
78       }
79       enum mpdr {
80         value 2;
81       }
82       enum switch {
83         value 3;
84       }
85       enum regen {
86         value 4;
87       }
88       enum regen-uni {
89         value 5;
90       }
91     }
92     description
93       "Identifier for Xponder node type
94        1. Transponder
95        2. Muxponder
96        3. OTN switchponder
97        4. Regenerator
98        5. Regenerator based on unidirectional model";
99   }
100
101   typedef port-qual {
102     type enumeration {
103       enum roadm-internal {
104         value 1;
105       }
106       enum roadm-external {
107         value 2;
108       }
109       enum xpdr-network {
110         value 3;
111       }
112       enum xpdr-client {
113         value 4;
114       }
115       enum otdr {
116         value 5;
117       }
118       enum switch-network {
119         value 6;
120       }
121       enum switch-client {
122         value 7;
123       }
124       enum ila-external {
125         value 8;
126       }
127       enum ila-internal {
128         value 9;
129       }
130     }
131   }
132
133   grouping physical-location {
134     leaf rack {
135       type string;
136       mandatory false;
137     }
138     leaf shelf {
139       type string;
140       mandatory false;
141     }
142     leaf slot {
143       type string;
144       mandatory false;
145     }
146     leaf subSlot {
147       type string;
148       mandatory false;
149     }
150   }
151 }