api/src/main/yang/service_path/transportpce-pce@2017-04-26.yang

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