ordmodels/device/src/main/yang/org-openroadm-de-operations@2016-10-14.yang

   1 module org-openroadm-de-operations {
   2   namespace "http://org/openroadm/de/operations";
   3   prefix org-openroadm-de-operations;
   4
   5   import org-openroadm-resource {
   6     prefix org-openroadm-resource;
   7     revision-date 2016-10-14;
   8   }
   9
  10   import org-openroadm-common-types {
  11     prefix org-openroadm-common-types;
  12     revision-date 2016-10-14;
  13   }
  14
  15   organization "Open ROADM MSA";
  16   contact
  17     "OpenROADM.org";
  18   description
  19     "YANG definitions of operations.
  20
  21      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  22      AT&T Intellectual Property.  All other rights reserved.
  23
  24      Redistribution and use in source and binary forms, with or without modification,
  25      are permitted provided that the following conditions are met:
  26
  27      * Redistributions of source code must retain the above copyright notice, this
  28        list of conditions and the following disclaimer.
  29      * Redistributions in binary form must reproduce the above copyright notice,
  30        this list of conditions and the following disclaimer in the documentation and/or
  31        other materials provided with the distribution.
  32      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  33        contributors may be used to endorse or promote products derived from this software
  34        without specific prior written permission.
  35
  36      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  37      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  38      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  39      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  40      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  42      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  43      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  44      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  45      POSSIBILITY OF SUCH DAMAGE.";
  46
  47   revision 2016-10-14 {
  48     description
  49       "Version 1.2";
  50   }
  51
  52   rpc restart {
  53     description
  54       "Restart a resource with warm/cold option. If no resource is provided or only the device name is provded, then the device itself will be restarted.
  55        Note that resources on the device will not be restartable";
  56     input {
  57       uses org-openroadm-resource:resource;
  58       leaf option{
  59         type enumeration{
  60           enum "warm"{
  61             value 1;
  62           }
  63           enum "cold"{
  64             value 2;
  65           }
  66         }
  67       }
  68     }
  69     output {
  70       uses org-openroadm-common-types:rpc-response-status;
  71     }
  72   }
  73   notification restart-notification {
  74     description
  75       "This Notification is sent when a resource on a device has completed a restart. This is sent as a result of restarts triggered via the
  76        restart RPC and other means.  The resource identified is the from the RPC request or the equivalment if the restart was triggered another way.";
  77     uses org-openroadm-resource:resource;
  78   }
  79 }