api/src/main/yang/servicehandler.yang

   1 module servicehandler {
   2   namespace "http://org/opendaylight/transportpce/servicehandler";
   3   prefix "org-opendaylight-transportpce-servicehandler";
   4
   5   import org-openroadm-common-types {
   6       prefix org-openroadm-common-types;
   7       revision-date 2016-10-14;
   8   }
   9   import org-openroadm-common-service-types {
  10     prefix org-openroadm-common-service-types;
  11   }
  12   import transportpce-common-service-path-types {
  13     prefix org-openroadm-common-service-path-types;
  14     revision-date 2017-04-26;
  15  }
  16
  17   organization
  18     "Open ROADM MSA";
  19   contact
  20     "OpenROADM.org";
  21   description
  22     "YANG definitions of services.
  23      Copyright © 2017 Orange, Inc. and others.  All rights reserved.
  24
  25      This model is derived from the OpenROADM service definition that includes the following notice:
  26
  27
  28       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  29       AT&T Intellectual Property.  All other rights reserved.
  30
  31       Redistribution and use in source and binary forms, with or without modification,
  32       are permitted provided that the following conditions are met:
  33
  34       * Redistributions of source code must retain the above copyright notice, this
  35         list of conditions and the following disclaimer.
  36       * Redistributions in binary form must reproduce the above copyright notice,
  37         this list of conditions and the following disclaimer in the documentation and/or
  38         other materials provided with the distribution.
  39       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  40         contributors may be used to endorse or promote products derived from this software
  41         without specific prior written permission.
  42
  43       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  44       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  45       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  46       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  47       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  48       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  49       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  50       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  51       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  52       POSSIBILITY OF SUCH DAMAGE";
  53
  54   revision 2017-09-30 {
  55     description
  56       "Version 1.2";
  57   }
  58
  59   rpc service-state-modify {
  60       input {
  61           leaf service-name {
  62               type string;
  63               mandatory true;
  64           }
  65           leaf operational-state {
  66               type org-openroadm-common-types:state;
  67           }
  68       }
  69       output {
  70         uses org-openroadm-common-service-types:configuration-response-common;
  71       }
  72       description
  73           "Just to test rpc restoration from org-openroadm-service";
  74   }
  75
  76   notification service-rpc-result-sh{
  77     description
  78       "This Notification indicates result of service RPC";
  79     leaf notification-type {
  80       type org-openroadm-common-service-types:service-notification-types;
  81     }
  82     uses org-openroadm-common-service-path-types:rpc-response-status-ex;
  83     uses org-openroadm-common-service-types:service-notification-result;
  84   }
  85 }