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