api/src/main/yang/stubrenderer.yang

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