ordmodels/common/src/main/yang/org-openroadm-equipment-states-types@2019-11-29.yang

   1 module org-openroadm-equipment-states-types {
   2   namespace "http://org/openroadm/equipment/states/types";
   3   prefix org-openroadm-equipment-states-types;
   4
   5   organization
   6     "Open ROADM MSA";
   7   contact
   8     "OpenROADM.org";
   9   description
  10     "YANG definitions for types of states of equipment (slot/subslot).
  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 2017-12-15 {
  47     description
  48       "Version 2.2";
  49   }
  50   revision 2017-06-26 {
  51     description
  52       "Version 2.0";
  53   }
  54   revision 2016-10-14 {
  55     description
  56       "Version 1.2";
  57   }
  58
  59   typedef admin-states {
  60     type enumeration {
  61       enum inService {
  62         value 1;
  63       }
  64       enum outOfService {
  65         value 2;
  66       }
  67       enum maintenance {
  68         value 3;
  69       }
  70     }
  71   }
  72
  73   typedef states {
  74     type enumeration {
  75       enum reserved-for-facility-planned {
  76         value 1;
  77         description
  78           "equipment is planned for use by a service";
  79       }
  80       enum not-reserved-planned {
  81         value 2;
  82         description
  83           "equipment is planned by not reserved for any purpose";
  84       }
  85       enum reserved-for-maintenance-planned {
  86         value 3;
  87         description
  88           "equipment is planned for use as a maintenance spare";
  89       }
  90       enum reserved-for-facility-unvalidated {
  91         value 4;
  92         description
  93           "equipment is reserved for use by a service but not
  94            validated against planned equipment";
  95       }
  96       enum not-reserved-unvalidated {
  97         value 5;
  98         description
  99           "equipment is not reserved for any purpose and
 100            not validated against planned equipment";
 101       }
 102       enum unknown-unvalidated {
 103         value 6;
 104         description
 105           "unknown equipment not validated against planned equipment";
 106       }
 107       enum reserved-for-maintenance-unvalidated {
 108         value 7;
 109         description
 110           "equipment is to be used for use as a maintenance spare
 111            but not validated against planned equipment";
 112       }
 113       enum reserved-for-facility-available {
 114         value 8;
 115         description
 116           "reserved for use by a service and available";
 117       }
 118       enum not-reserved-available {
 119         value 9;
 120         description
 121           "not reserved for use by a service and available";
 122       }
 123       enum reserved-for-maintenance-available {
 124         value 10;
 125         description
 126           "reserved as a maintenance spare and available";
 127       }
 128       enum reserved-for-reversion-inuse {
 129         value 11;
 130         description
 131           "equipment that is reserved as part of a home path
 132            for a service that has been temporarily re-routed";
 133       }
 134       enum not-reserved-inuse {
 135         value 12;
 136         description
 137           "equipment in use for a service";
 138       }
 139       enum reserved-for-maintenance-inuse {
 140         value 13;
 141         description
 142           "maintenance spare equipment that is in use as a
 143            maintenance spare";
 144       }
 145     }
 146   }
 147 }