ordmodels/network/src/main/yang/org-openroadm-network-topology-types@2020-03-27.yang

   1 module org-openroadm-network-topology-types {
   2   yang-version 1.1;
   3   namespace "http://org/openroadm/network/topology/types";
   4   prefix org-openroadm-network-topology-types;
   5
   6   import ietf-network {
   7     prefix nd;
   8     revision-date 2018-02-26;
   9   }
  10   import ietf-network-topology {
  11     prefix nwt;
  12     revision-date 2018-02-26;
  13   }
  14   import org-openroadm-switching-pool-types {
  15     prefix org-openroadm-switching-pool-types;
  16     revision-date 2019-11-29;
  17   }
  18   import org-openroadm-port-types {
  19     prefix org-openroadm-port-types;
  20     revision-date 2020-03-27;
  21   }
  22
  23   organization
  24     "OPEN ROADM MSA";
  25   contact
  26     "www.OpenROADM.org.";
  27   description
  28     "Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  29      All other rights reserved.
  30
  31      Redistribution and use in source and binary forms, with or without modification,
  32      are permitted provided that the following conditions are met:
  33
  34      * Redistributions of source code must retain the above copyright notice, this
  35        list of conditions and the following disclaimer.
  36      * Redistributions in binary form must reproduce the above copyright notice,
  37        this list of conditions and the following disclaimer in the documentation and/or
  38        other materials provided with the distribution.
  39      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  40        contributors may be used to endorse or promote products derived from this software
  41        without specific prior written permission.
  42
  43      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  44      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  45      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  46      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  47      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  48      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  49      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  50      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  51      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  52      POSSIBILITY OF SUCH DAMAGE.";
  53
  54   revision 2020-03-27 {
  55     description
  56       "Version 7.0.0";
  57   }
  58   revision 2019-11-29 {
  59     description
  60       "Version 6.1.0";
  61   }
  62   revision 2018-11-30 {
  63     description
  64       "Version 4.1.0";
  65   }
  66   revision 2017-12-15 {
  67     description
  68       "Version 2.2";
  69   }
  70
  71   grouping xpdr-tp-bandwidth-sharing {
  72     list tp-bandwidth-sharing {
  73       key "tp-sharing-id";
  74       leaf tp-sharing-id {
  75         type uint16;
  76       }
  77       leaf-list tp-list {
  78         type nwt:tp-id;
  79       }
  80       leaf shared-bandwidth {
  81         type uint16;
  82         units "Gbps";
  83       }
  84       list possible-tp-config {
  85         key "config-id";
  86         leaf config-id {
  87           type uint16;
  88         }
  89         list tp-if-type-config {
  90           key "tp-name";
  91           leaf tp-name {
  92             type leafref {
  93               path "/nd:networks/nd:network/nd:node/nwt:termination-point/nwt:tp-id";
  94             }
  95             description
  96               "termination-point identifier";
  97           }
  98           leaf-list tp-if-type {
  99             type identityref {
 100               base org-openroadm-port-types:supported-if-capability;
 101             }
 102           }
 103           leaf otsi-rate {
 104             type uint16;
 105             units "Gbps";
 106             description
 107               "Optical Tributary Signal (OTSi) rate in Gbps";
 108           }
 109         }
 110       }
 111     }
 112   }
 113
 114   grouping xpdr-odu-switching-pools {
 115     list odu-switching-pools {
 116       key "switching-pool-number";
 117       leaf switching-pool-number {
 118         type uint16;
 119         description
 120           "Unique identifier for this odu-switching-pool";
 121       }
 122       leaf switching-pool-type {
 123         type org-openroadm-switching-pool-types:switching-pool-types;
 124       }
 125       list non-blocking-list {
 126         key "nbl-number";
 127         description
 128           "List of ports in a non-blocking switch element";
 129         leaf nbl-number {
 130           type uint16;
 131           description
 132             "Identifier for this non-blocking-list. Unique within odu-switching-pool";
 133         }
 134         leaf interconnect-bandwidth-unit {
 135           type uint32;
 136           description
 137             "Switch fabric interconnect bandwidth unit rate in bits per second.
 138              Represents granularity of switch fabric";
 139         }
 140         leaf capable-interconnect-bandwidth {
 141           type uint32;
 142           description
 143             "Total interconnect bandwidth for a non-blocking element expressed as
 144              number of inter-connect-bandwidth units";
 145         }
 146         leaf available-interconnect-bandwidth {
 147           type uint32;
 148           description
 149             "Total interconnect bandwidth available for a non-blocking element can use as
 150              number of inter-connect-bandwidth units";
 151         }
 152         leaf-list tp-list {
 153           type nwt:tp-id;
 154           description
 155             "Termination point. Unique within device";
 156         }
 157       }
 158     }
 159   }
 160
 161   grouping xpdr-otn-tail-attributes {
 162     leaf tp-id {
 163       type nwt:tp-id;
 164     }
 165     leaf network-ref {
 166       type leafref {
 167         path "/nd:networks/nd:network/nd:network-id";
 168       }
 169       description
 170         "Used to reference a network, for example an underlay
 171          network.";
 172     }
 173     leaf node-ref {
 174       type leafref {
 175         path "/nd:networks/nd:network[nd:network-id=current()/../network-ref]/nd:node/nd:node-id";
 176       }
 177       description
 178         "Used to reference a node.
 179          Nodes are identified relative to the network they are
 180          contained in.";
 181     }
 182   }
 183 }