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