| Stephane St-Laurent | 8adec97 | 2018-05-15 13:52:41 -0700 | [diff] [blame^] | 1 | module opendevice-edfa {
|
| 2 | yang-version 1;
|
| 3 | namespace "http://www.opendevice.net/yang/opendevice-edfa";
|
| 4 | prefix "od-edfa";
|
| 5 | import opendevice-types {
|
| 6 | prefix "od-types";
|
| 7 | revision-date 2017-10-08;
|
| 8 | }
|
| 9 |
|
| 10 |
|
| 11 | organization "Infinera";
|
| 12 | contact
|
| 13 | "support@infinera.com";
|
| 14 | description
|
| 15 | "This model describes configuration and operational state data for
|
| 16 | optical amplifiers, deployed as part of a transport line system.";
|
| 17 | revision 2018-05-15 {
|
| 18 | description "cleanup comment";
|
| 19 | }
|
| 20 |
|
| 21 | revision 2017-10-08;
|
| 22 | revision 2017-09-19 {
|
| 23 | description "Remove identityref";
|
| 24 | }
|
| 25 |
|
| 26 | revision 2017-07-08 {
|
| 27 | description "Initial revision";
|
| 28 | }
|
| 29 |
|
| 30 | feature gain-mask-supported {
|
| 31 | description "This feature means the device supports gain-mask specification.";
|
| 32 | }
|
| 33 | feature tilk-mask-supported {
|
| 34 | description "This feature means the device supports tilk-mask specification.";
|
| 35 | }
|
| 36 | feature switched-gain-supported {
|
| 37 | description "This feature means the device supports switched-gain.";
|
| 38 | }
|
| 39 | typedef optical-amplification-type {
|
| 40 | type enumeration {
|
| 41 | enum edfa {
|
| 42 | value 1;
|
| 43 | }
|
| 44 | enum backward-raman {
|
| 45 | value 2;
|
| 46 | description "Backward pumping Raman amplifier";
|
| 47 | }
|
| 48 | enum forward-raman {
|
| 49 | value 3;
|
| 50 | description "Forward pumping Raman amplifier";
|
| 51 | }
|
| 52 | }
|
| 53 | description "Type definition for different types of optical amplifiers";
|
| 54 | }
|
| 55 | typedef optical-control-mode {
|
| 56 | type enumeration {
|
| 57 | enum constant-gain {
|
| 58 | value 1;
|
| 59 | description "Value indicates that constant-gain is the optical-control-mode";
|
| 60 | }
|
| 61 | enum constant-power {
|
| 62 | value 2;
|
| 63 | description "Value indicates that constant-power is the control-mode";
|
| 64 | }
|
| 65 | }
|
| 66 | default "constant-gain";
|
| 67 | description
|
| 68 | "Type definition for different types of optical amplifier
|
| 69 | operating modes";
|
| 70 | }
|
| 71 | typedef operational-mode {
|
| 72 | type enumeration {
|
| 73 | enum auto {
|
| 74 | value 1;
|
| 75 | description "Under this mode, the optical amplifier configuration (system) is controlled by a controller";
|
| 76 | }
|
| 77 | enum manual {
|
| 78 | value 2;
|
| 79 | description "Under this mode, the optical amplifier configuration (base) is controled manually";
|
| 80 | }
|
| 81 | }
|
| 82 | default "auto";
|
| 83 | description "Determine the configuration set used to configure the optical amplifier";
|
| 84 | }
|
| 85 | typedef gain-range {
|
| 86 | type enumeration {
|
| 87 | enum gain-range-1;
|
| 88 | enum gain-range-2;
|
| 89 | enum gain-range-3;
|
| 90 | }
|
| 91 | }
|
| 92 |
|
| 93 | grouping edfa-operational-spectrum-spec {
|
| 94 | description "Define the operational band associated to the EDFA ";
|
| 95 | container optical-spectrum-spec {
|
| 96 | leaf optical-band-type {
|
| 97 | type identityref {
|
| 98 | base od-types:optical-band;
|
| 99 | }
|
| 100 | }
|
| 101 | leaf lower-frequency {
|
| 102 | type od-types:dwdm-frequency-mhz;
|
| 103 | }
|
| 104 | leaf upper-frequency {
|
| 105 | type od-types:dwdm-frequency-mhz;
|
| 106 | }
|
| 107 | }
|
| 108 | }
|
| 109 | grouping edfa-gain-mask-spec {
|
| 110 | container gain-mask-specs {
|
| 111 | list gain-mask {
|
| 112 | key "min-gain max-gain";
|
| 113 | leaf min-gain {
|
| 114 | type decimal64 {
|
| 115 | fraction-digits 2;
|
| 116 | }
|
| 117 | units dB;
|
| 118 | }
|
| 119 | leaf max-gain {
|
| 120 | type decimal64 {
|
| 121 | fraction-digits 2;
|
| 122 | }
|
| 123 | units dB;
|
| 124 | }
|
| 125 | list gain-mask {
|
| 126 | key index;
|
| 127 | min-elements 1;
|
| 128 | max-elements 32;
|
| 129 | ordered-by system;
|
| 130 | leaf index {
|
| 131 | type uint8;
|
| 132 | }
|
| 133 | container gain-polygone {
|
| 134 | container low-gain-min-power-out {
|
| 135 | leaf pwr-in {
|
| 136 | type decimal64 {
|
| 137 | fraction-digits 2;
|
| 138 | }
|
| 139 | units dBm;
|
| 140 | }
|
| 141 | leaf pwr-out {
|
| 142 | type decimal64 {
|
| 143 | fraction-digits 2;
|
| 144 | }
|
| 145 | units dBm;
|
| 146 | }
|
| 147 | }
|
| 148 | container low-gain-max-power-out {
|
| 149 | leaf pwr-in {
|
| 150 | type decimal64 {
|
| 151 | fraction-digits 2;
|
| 152 | }
|
| 153 | units dBm;
|
| 154 | }
|
| 155 | leaf pwr-out {
|
| 156 | type decimal64 {
|
| 157 | fraction-digits 2;
|
| 158 | }
|
| 159 | units dBm;
|
| 160 | }
|
| 161 | }
|
| 162 | container high-gain-min-power-out {
|
| 163 | leaf pwr-in {
|
| 164 | type decimal64 {
|
| 165 | fraction-digits 2;
|
| 166 | }
|
| 167 | units dBm;
|
| 168 | }
|
| 169 | leaf pwr-out {
|
| 170 | type decimal64 {
|
| 171 | fraction-digits 2;
|
| 172 | }
|
| 173 | units dBm;
|
| 174 | }
|
| 175 | }
|
| 176 | container high-gain-max-power-out {
|
| 177 | leaf pwr-in {
|
| 178 | type decimal64 {
|
| 179 | fraction-digits 2;
|
| 180 | }
|
| 181 | units dBm;
|
| 182 | }
|
| 183 | leaf pwr-out {
|
| 184 | type decimal64 {
|
| 185 | fraction-digits 2;
|
| 186 | }
|
| 187 | units dBm;
|
| 188 | }
|
| 189 | }
|
| 190 | }
|
| 191 | }
|
| 192 | }
|
| 193 | }
|
| 194 | }
|
| 195 | grouping edfa-tild-mask_spec;
|
| 196 | grouping edfa-noise-figure-spec;
|
| 197 | grouping edfa-specification-top {
|
| 198 | container specification {
|
| 199 | container state {
|
| 200 | config false;
|
| 201 | uses edfa-operational-spectrum-spec;
|
| 202 | uses edfa-gain-mask-spec;
|
| 203 | uses edfa-tild-mask_spec;
|
| 204 | uses edfa-noise-figure-spec;
|
| 205 | }
|
| 206 | }
|
| 207 | }
|
| 208 | grouping edfa-system-config {
|
| 209 | uses edfa-base-config;
|
| 210 | }
|
| 211 | grouping edfa-system-state {
|
| 212 | uses edfa-base-state;
|
| 213 | }
|
| 214 | grouping edfa-system-top {
|
| 215 | container system {
|
| 216 | container config {
|
| 217 | uses edfa-system-config;
|
| 218 | }
|
| 219 | container state {
|
| 220 | config false;
|
| 221 | uses edfa-system-config;
|
| 222 | uses edfa-system-state;
|
| 223 | }
|
| 224 | }
|
| 225 | }
|
| 226 | grouping edfa-base-config {
|
| 227 |
|
| 228 | leaf target-gain {
|
| 229 | type decimal64 {
|
| 230 | fraction-digits 2;
|
| 231 | range "0..max";
|
| 232 | }
|
| 233 | units dB;
|
| 234 | description "When in constantGain mode, this indicates the target gain in dB the amplifier is to maintain.";
|
| 235 | }
|
| 236 | leaf target-tilt {
|
| 237 | type decimal64 {
|
| 238 | fraction-digits 2;
|
| 239 | }
|
| 240 | units dB;
|
| 241 | description
|
| 242 | "Indicates the gain tilt applied over the spectrum. This is a a measure
|
| 243 | in dB of the gain slope from low to high frequency. A gain tilt of 0 dB means no tilt.";
|
| 244 |
|
| 245 | }
|
| 246 | leaf target-output-power {
|
| 247 | type decimal64 {
|
| 248 | fraction-digits 2;
|
| 249 | }
|
| 250 | units dBm;
|
| 251 | description
|
| 252 | "When in constantPower mode, this indicates the target power in
|
| 253 | dBm the amplifier is to maintain.";
|
| 254 | }
|
| 255 | leaf control-mode {
|
| 256 | type optical-control-mode;
|
| 257 | description "The operating mode of the amplifier";
|
| 258 | }
|
| 259 | leaf gain-range-selection {
|
| 260 | type gain-range;
|
| 261 | default "gain-range-1";
|
| 262 | }
|
| 263 |
|
| 264 | leaf enabled {
|
| 265 | type boolean;
|
| 266 | description "Turns power on / off to the amplifiers gain module.";
|
| 267 | } }
|
| 268 | grouping edfa-base-state{
|
| 269 | leaf ingress-sensor-power {
|
| 270 | type decimal64 {
|
| 271 | fraction-digits 3;
|
| 272 | }
|
| 273 | units dBm;
|
| 274 | }
|
| 275 | leaf egress-sensor-power {
|
| 276 | type decimal64 {
|
| 277 | fraction-digits 3;
|
| 278 | }
|
| 279 | units dBm;
|
| 280 | }
|
| 281 | leaf measured-sensor-gain {
|
| 282 | type decimal64 {
|
| 283 | fraction-digits 3;
|
| 284 | }
|
| 285 | units dB;
|
| 286 | }
|
| 287 | leaf psd-ase-actual-mc-band {
|
| 288 | type decimal64 {
|
| 289 | fraction-digits 5;
|
| 290 | }
|
| 291 | units dBm/GHz;
|
| 292 | }
|
| 293 | }
|
| 294 | grouping edfa-base-top {
|
| 295 | container base {
|
| 296 | container config {
|
| 297 | uses edfa-base-config;
|
| 298 | }
|
| 299 | container state {
|
| 300 | config false;
|
| 301 | uses edfa-base-config;
|
| 302 | uses edfa-base-state;
|
| 303 | }
|
| 304 | }
|
| 305 | }
|
| 306 |
|
| 307 | grouping edfa-config {
|
| 308 | description "Configuration data for optical amplifiers";
|
| 309 | leaf name {
|
| 310 | type string;
|
| 311 | description
|
| 312 | "User-defined name assigned to identify a specific amplifier
|
| 313 | in the device";
|
| 314 | }
|
| 315 | leaf controller-mode {
|
| 316 | type operational-mode ;
|
| 317 | description
|
| 318 | "Select the mode of operation of the device, manual or autoo. In manual mode, the base configuration
|
| 319 | is used. In auto, the system configuration is used";
|
| 320 |
|
| 321 | }
|
| 322 |
|
| 323 | }
|
| 324 | grouping edfa-state {
|
| 325 | description
|
| 326 | "Operational state data for optical amplifiers
|
| 327 | ";
|
| 328 | }
|
| 329 |
|
| 330 |
|
| 331 | grouping edfa-top {
|
| 332 | description "Top-level grouping for EDFA optical amplifier data";
|
| 333 | container edfas {
|
| 334 | description "Enclosing container for list of edfas
|
| 335 | ";
|
| 336 | list edfa {
|
| 337 | key name;
|
| 338 | description "List of EDFA optical amplifiers present in the device";
|
| 339 | leaf name {
|
| 340 | type leafref {
|
| 341 | path "../config/name";
|
| 342 | }
|
| 343 | description "Reference to the name of the amplifier";
|
| 344 | }
|
| 345 | container config {
|
| 346 | description "Configuration data for the amplifier";
|
| 347 | uses edfa-config;
|
| 348 | }
|
| 349 | container state {
|
| 350 | config false;
|
| 351 | description "Operational state data for the amplifier";
|
| 352 | uses edfa-config;
|
| 353 |
|
| 354 | uses edfa-state;
|
| 355 | }
|
| 356 | uses edfa-base-top;
|
| 357 | uses edfa-system-top;
|
| 358 |
|
| 359 | }
|
| 360 |
|
| 361 | }
|
| 362 |
|
| 363 | }
|
| 364 |
|
| 365 | uses edfa-top;
|
| 366 |
|
| 367 | } |