api/src/main/yang/service_path/transportpce-renderer@2020-05-20.yang

   1 module transportpce-renderer {
   2   namespace "http://org/opendaylight/transportpce/renderer";
   3   prefix org-opendaylight-transportpce-renderer;
   4
   5   import org-openroadm-common-service-types {
   6     prefix org-openroadm-common-service-types;
   7     revision-date 2019-05-31;
   8   }
   9   import transportpce-common-service-path-types {
  10     prefix transportpce-common-service-path-types;
  11   }
  12   import org-openroadm-topology {
  13     prefix org-openroadm-topology;
  14     revision-date 2019-05-31;
  15   }
  16   import transportpce-pathDescription {
  17     prefix transportpce-pathDescription;
  18   }
  19
  20   organization
  21     "transportPCE";
  22   contact
  23     "transportPCE committers - ODL";
  24   description
  25     "YANG definitions of C interface (transportPCE). Adapted from service definition (openroadm)
  26      Copyright © 2017 Orange, Inc. and others.  All rights reserved.
  27
  28      openroadm copyright:
  29       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  30       AT&T Intellectual Property.  All other rights reserved.
  31
  32       Redistribution and use in source and binary forms, with or without modification,
  33       are permitted provided that the following conditions are met:
  34
  35       * Redistributions of source code must retain the above copyright notice, this
  36         list of conditions and the following disclaimer.
  37       * Redistributions in binary form must reproduce the above copyright notice,
  38         this list of conditions and the following disclaimer in the documentation and/or
  39         other materials provided with the distribution.
  40       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  41         contributors may be used to endorse or promote products derived from this software
  42         without specific prior written permission.
  43
  44       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  45       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  46       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  47       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  48       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  49       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  50       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  51       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  52       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  53       POSSIBILITY OF SUCH DAMAGE";
  54
  55   revision 2020-05-20 {
  56     description
  57       "Version 1.6.1";
  58   }
  59   revision 2017-10-17 {
  60     description
  61       "Version 1.6";
  62   }
  63   revision 2017-02-28 {
  64     description
  65       "Initial revision of renderer model version 1.5";
  66   }
  67
  68   rpc service-implementation-request {
  69     input {
  70       leaf service-name {
  71         type string;
  72         mandatory true;
  73         description
  74           "Identifier for the service to be created in
  75            the ROADM network, e.g., CLFI, CLCI, etc. This is reported against the service, but may not get reflected in the service in the network.";
  76       }
  77       leaf connection-type {
  78         type org-openroadm-common-service-types:connection-type;
  79       }
  80       uses transportpce-common-service-path-types:service-handler-header;
  81       container service-a-end {
  82         uses transportpce-common-service-path-types:service-endpoint-sp;
  83       }
  84       container service-z-end {
  85         uses transportpce-common-service-path-types:service-endpoint-sp;
  86       }
  87       container path-description {
  88         uses transportpce-pathDescription:path-description;
  89       }
  90     }
  91     output {
  92       uses org-openroadm-common-service-types:configuration-response-common;
  93     }
  94   }
  95
  96   rpc service-delete {
  97     input {
  98       leaf service-name {
  99         type string;
 100         mandatory true;
 101         description
 102           "Identifier for the service to be created in
 103            the ROADM network, e.g., CLFI, CLCI, etc. This is reported against the service, but may not get reflected in the service in the network.";
 104       }
 105       uses transportpce-common-service-path-types:service-handler-header;
 106     }
 107     output {
 108       uses org-openroadm-common-service-types:configuration-response-common;
 109     }
 110   }
 111
 112   notification service-rpc-result-sp {
 113     description
 114       "This Notification indicates result of  service RPC and provides the topology";
 115     leaf notification-type {
 116       type transportpce-common-service-path-types:service-path-notification-types;
 117     }
 118     container path-topology {
 119       uses org-openroadm-topology:topology;
 120     }
 121     uses transportpce-common-service-path-types:rpc-response-status-ex;
 122     uses org-openroadm-common-service-types:service-notification-result;
 123   }
 124 }