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