ordmodels/common/src/main/yang/org-openroadm-equipment-states-types@2016-10-14.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 "Open ROADM MSA";
   6   contact
   7     "OpenROADM.org";
   8   description
   9     "YANG definitions for types of states of equipment (slot/subslot).
  10
  11      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  12      AT&T Intellectual Property.  All other rights reserved.
  13
  14      Redistribution and use in source and binary forms, with or without modification,
  15      are permitted provided that the following conditions are met:
  16
  17      * Redistributions of source code must retain the above copyright notice, this
  18        list of conditions and the following disclaimer.
  19      * Redistributions in binary form must reproduce the above copyright notice,
  20        this list of conditions and the following disclaimer in the documentation and/or
  21        other materials provided with the distribution.
  22      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  23        contributors may be used to endorse or promote products derived from this software
  24        without specific prior written permission.
  25
  26      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  27      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  30      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  32      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  33      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35      POSSIBILITY OF SUCH DAMAGE.";
  36
  37   revision 2016-10-14 {
  38     description
  39       "Version 1.2";
  40   }
  41
  42   typedef admin-states {
  43     type enumeration {
  44       enum "inService" {
  45         value 1;
  46       }
  47       enum "outOfService" {
  48         value 2;
  49       }
  50       enum "maintenance" {
  51         value 3;
  52       }
  53     }
  54   }
  55
  56   typedef states {
  57     type enumeration {
  58       enum "reserved-for-facility-planned" {
  59         value 1;
  60         description
  61           "equipment is planned for use by a service";
  62       }
  63       enum "not-reserved-planned" {
  64         value 2;
  65         description
  66           "equipment is planned by not reserved for any purpose";
  67       }
  68       enum "reserved-for-maintenance-planned" {
  69         value 3;
  70         description
  71           "equipment is planned for use as a maintenance spare";
  72       }
  73       enum "reserved-for-facility-unvalidated" {
  74         value 4;
  75         description
  76           "equipment is reserved for use by a service but not
  77            validated against planned equipment";
  78       }
  79       enum "not-reserved-unvalidated" {
  80         value 5;
  81         description
  82           "equipment is not reserved for any purpose and
  83            not validated against planned equipment";
  84       }
  85       enum "unknown-unvalidated" {
  86         value 6;
  87         description
  88           "unknown equipment not validated against planned equipment";
  89       }
  90       enum "reserved-for-maintenance-unvalidated" {
  91         value 7;
  92         description
  93           "equipment is to be used for use as a maintenance spare
  94            but not validated against planned equipment";
  95       }
  96       enum "reserved-for-facility-available" {
  97         value 8;
  98         description
  99           "reserved for use by a service and available";
 100       }
 101       enum "not-reserved-available" {
 102         value 9;
 103         description
 104           "not reserved for use by a service and available";
 105       }
 106       enum "reserved-for-maintenance-available" {
 107         value 10;
 108         description
 109           "reserved as a maintenance spare and available";
 110       }
 111       enum "reserved-for-reversion-inuse" {
 112         value 11;
 113         description
 114           "equipiment that is reserved as part of a home path
 115            for a service that has been temporarily re-routed";
 116       }
 117       enum "not-reserved-inuse" {
 118         value 12;
 119         description
 120           "equipment in use for a service";
 121       }
 122       enum "reserved-for-maintenance-inuse" {
 123         value 13;
 124         description
 125           "maintenance spare equipment that is in use as a
 126            maintenance spare";
 127       }
 128     }
 129   }
 130 }