api/src/main/yang/service_path/transportpce-renderer@2017-10-17.yang

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