ordmodels/common/src/main/yang/org-openroadm-resource@2018-10-19.yang

   1 module org-openroadm-resource {
   2   namespace "http://org/openroadm/resource";
   3   prefix org-openroadm-resource;
   4
   5   import org-openroadm-resource-types {
   6     prefix org-openroadm-resource-types;
   7     revision-date 2018-10-19;
   8   }
   9
  10   organization
  11     "Open ROADM MSA";
  12   contact
  13     "OpenROADM.org";
  14   description
  15     "YANG definitions of resources.
  16
  17       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  18       AT&T Intellectual Property.  All other rights reserved.
  19
  20       Redistribution and use in source and binary forms, with or without modification,
  21       are permitted provided that the following conditions are met:
  22
  23       * Redistributions of source code must retain the above copyright notice, this
  24         list of conditions and the following disclaimer.
  25       * Redistributions in binary form must reproduce the above copyright notice,
  26         this list of conditions and the following disclaimer in the documentation and/or
  27         other materials provided with the distribution.
  28       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  29         contributors may be used to endorse or promote products derived from this software
  30         without specific prior written permission.
  31
  32       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  33       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  34       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  35       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  36       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  37       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  38       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  39       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41       POSSIBILITY OF SUCH DAMAGE";
  42
  43   revision 2018-10-19 {
  44     description
  45       "Version 2.2.1";
  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 resource {
  69     description
  70       "This resource identifier is intended to provide a generic identifer
  71        for any resource that can be used without specific knowledge of
  72        the resource.";
  73     container device {
  74       description
  75         "Device of the resource, used only when the system using this
  76          model report on more than one device. ";
  77       uses org-openroadm-resource-types:device-id;
  78     }
  79     container resource {
  80       choice resource {
  81         case circuit-pack {
  82           uses org-openroadm-resource-types:circuit-pack-name;
  83         }
  84         case port {
  85           container port {
  86             uses org-openroadm-resource-types:port-name;
  87           }
  88         }
  89         case connection {
  90           uses org-openroadm-resource-types:connection-name {
  91             refine "connection-name" {
  92               mandatory true;
  93             }
  94           }
  95         }
  96         case physical-link {
  97           uses org-openroadm-resource-types:physical-link-name;
  98         }
  99         case internal-link {
 100           uses org-openroadm-resource-types:internal-link-name;
 101         }
 102         case shelf {
 103           uses org-openroadm-resource-types:shelf-name;
 104         }
 105         case srg {
 106           uses org-openroadm-resource-types:srg-number {
 107             refine "srg-number" {
 108               mandatory true;
 109             }
 110           }
 111         }
 112         case degree {
 113           uses org-openroadm-resource-types:degree-number {
 114             refine "degree-number" {
 115               mandatory true;
 116             }
 117           }
 118         }
 119         case service {
 120           uses org-openroadm-resource-types:service-name;
 121         }
 122         case interface {
 123           uses org-openroadm-resource-types:interface-name;
 124         }
 125         case odu-sncp-pg {
 126           uses org-openroadm-resource-types:odu-sncp-pg-name;
 127         }
 128         case other {
 129           uses org-openroadm-resource-types:other-resource-id;
 130         }
 131         case device {
 132           uses org-openroadm-resource-types:device-id {
 133             refine "node-id" {
 134               mandatory true;
 135             }
 136           }
 137         }
 138         case line-amplifier {
 139           uses org-openroadm-resource-types:amp-number;
 140         }
 141         case xponder {
 142           uses org-openroadm-resource-types:xpdr-number;
 143         }
 144         case versioned-service {
 145           uses org-openroadm-resource-types:versioned-service-name;
 146         }
 147         case temp-service {
 148           uses org-openroadm-resource-types:temp-service-name;
 149         }
 150       }
 151     }
 152     container resourceType {
 153       uses org-openroadm-resource-types:resource-type;
 154     }
 155   }
 156 }