api/src/main/yang/service_path/transportpce-pce.yang

   1 module transportpce-pce {
   2   namespace "http://org/transportpce/B-interface/pce";
   3   prefix 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-10-17 {
  60     description
  61       "Version 1.6";
  62   }
  63
  64   rpc path-computation-request {
  65     input {
  66       leaf service-name {
  67         type string;
  68         description
  69           "Identifier for the service to be created in
  70            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.";
  71         mandatory true;
  72       }
  73       leaf resource-reserve {
  74            type boolean;
  75            description
  76                 "indicates if resources (from local PCE topology) must be reserved until further notice (cancel-resource-reserve or topology update)";
  77            mandatory true;
  78       }
  79       uses transportpce-common-service-path-types:service-handler-header;
  80       container service-a-end {
  81         uses transportpce-common-service-path-types:service-endpoint-sp;
  82       }
  83       container service-z-end {
  84         uses transportpce-common-service-path-types:service-endpoint-sp;
  85       }
  86       uses transportpce-routing-constraints:routing-constraints-sp;
  87     }
  88     output {
  89       uses org-openroadm-common-service-types:configuration-response-common;
  90       uses transportpce-common-service-path-types:response-parameters-sp;
  91     }
  92   }
  93
  94   rpc cancel-resource-reserve {
  95     input {
  96       leaf service-name {
  97         type string;
  98         mandatory true;
  99       }
 100       uses transportpce-common-service-path-types:service-handler-header;
 101     }
 102     output {
 103       uses org-openroadm-common-service-types:configuration-response-common;
 104     }
 105   }
 106
 107 notification service-path-rpc-result {
 108     description
 109       "This Notification indicates result of  service RPC";
 110     leaf notification-type {
 111       type transportpce-common-service-path-types:service-path-notification-types;
 112     }
 113     container path-description {
 114            uses transportpce-pathDescription:path-description;
 115     }
 116     uses transportpce-common-service-path-types:rpc-response-status-ex;
 117     uses org-openroadm-common-service-types:service-notification-result;
 118   }
 119
 120   grouping stubpce-path-description {
 121       leaf path-name {
 122           type string;
 123           description
 124             "Identifier for the pathDescription to be created in
 125              the ROADM network, e.g., CLFI, CLCI, etc.";
 126           mandatory true;
 127         }
 128       uses transportpce-pathDescription:path-description;
 129   }
 130
 131   container path-description-list {
 132     description
 133       "List of pathDescription. Can only be created, deleted, modified, etc. using special RPCs.";
 134     list pathDescriptions {
 135       key "path-name";
 136       uses stubpce-path-description;
 137     }
 138   }
 139
 140 }