ordmodels/common/src/main/yang/org-openroadm-common-node-types@2021-05-28.yang

   1 module org-openroadm-common-node-types {
   2   namespace "http://org/openroadm/common-node-types";
   3   prefix org-openroadm-common-node-types;
   4
   5   organization
   6     "Open ROADM MSA";
   7   contact
   8     "OpenROADM.org";
   9   description
  10     "YANG definitions of common node 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 2021-05-28 {
  39     description
  40       "Version 9.1";
  41   }
  42   revision 2020-12-11 {
  43     description
  44       "Version 8.1";
  45   }
  46   revision 2019-11-29 {
  47     description
  48       "Version 6.1.0";
  49   }
  50   revision 2018-11-30 {
  51     description
  52       "Version 4.1.0";
  53   }
  54   revision 2018-09-28 {
  55     description
  56       "Version 4.0.0";
  57   }
  58   revision 2018-03-30 {
  59     description
  60       "Version 3.0.0";
  61   }
  62
  63   typedef node-types {
  64     type enumeration {
  65       enum rdm {
  66         value 1;
  67       }
  68       enum xpdr {
  69         value 2;
  70       }
  71       enum ila {
  72         value 3;
  73       }
  74       enum extplug {
  75         value 4;
  76       }
  77     }
  78     description
  79       "Identifier for node type
  80        1. rdm for ROADM
  81        2. xpdr for Transponder, Regen
  82        3. ila for in-line amplifier
  83        4. extplug for external pluggable";
  84   }
  85
  86   typedef node-subtypes {
  87     type enumeration {
  88       enum none {
  89         value 1;
  90         description
  91           "The none-enum indicates there is no node-subtype refinement.
  92            Standard OpenROADM node properties apply in this case. If an
  93            optional-leaf of node-subtypes is not present, the behaviour is the
  94            same as the none-enum.";
  95       }
  96       enum edge-optical-spec {
  97         value 2;
  98         description
  99           "This enum refines a ROADM node-type. It indicates that node conforms
 100            to edge optical specifications as defined in the OpenROADM MSA
 101            Specification: MW-MW(Edge), MW-Wr(Edge), and Local Control (Edge).";
 102       }
 103     }
 104     description
 105       "Identifier for node-subtype. Provides refinement of node-type.";
 106   }
 107
 108   typedef xpdr-node-types {
 109     type enumeration {
 110       enum tpdr {
 111         value 1;
 112       }
 113       enum mpdr {
 114         value 2;
 115       }
 116       enum switch {
 117         value 3;
 118       }
 119       enum regen {
 120         value 4;
 121       }
 122       enum regen-uni {
 123         value 5;
 124       }
 125     }
 126     description
 127       "Identifier for Xponder node type
 128        1. Transponder
 129        2. Muxponder
 130        3. OTN switchponder
 131        4. Regenerator
 132        5. Regenerator based on unidirectional model
 133
 134        Xponder types are modeled in one of two ways:
 135
 136        Type 1: The xponder ports are configured with port-qual of xpdr-client or
 137 xpdr-network, the xponder connectivity is advertised using connection-map, and
 138 no explicit cross connects are provisioned.
 139
 140        Type 2: The xponder ports are configured with port-qual of switch-network
 141 or switch-client, the connectivity is advertised using switching-pool, and
 142 explicit cross connects are provisioned.
 143
 144        Type 1 applies to transponders, unidirectional regenerators, and bidirectional regenerators.
 145        Type 2 applies to muxponders and switchponders.";
 146   }
 147
 148   typedef node-id-type {
 149     type string {
 150       length "7..63";
 151       pattern '([a-zA-Z][a-zA-Z0-9-]{5,61}[a-zA-Z0-9])' {
 152         error-message
 153           "A node-id must be 7 to 63 characters in length.
 154            A node-id can contain letters, numbers, and hyphens.
 155            The first character must be a letter.
 156            The last character must be a letter or number.";
 157       }
 158     }
 159     description
 160       "Globally unique identifier for a device.";
 161   }
 162 }