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