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     revision-date 2016-10-14;
  11   }
  12   import transportpce-common-service-path-types {
  13     prefix transportpce-common-service-path-types;
  14     revision-date 2017-10-16;
  15   }
  16   import org-openroadm-topology {
  17     prefix org-openroadm-topology;
  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 C 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-02-28" {
  60       description "Initial revision of renderer model version 1.5";
  61   }
  62
  63   revision 2017-10-17 {
  64     description
  65       "Version 1.6";
  66   }
  67
  68   rpc service-implementation-request {
  69     input {
  70       leaf service-name {
  71         type string;
  72         description
  73           "Identifier for the service to be created in
  74            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.";
  75         mandatory true;
  76       }
  77       uses transportpce-common-service-path-types:service-handler-header;
  78       container service-a-end {
  79         uses transportpce-common-service-path-types:service-endpoint-sp;
  80       }
  81       container service-z-end {
  82         uses transportpce-common-service-path-types:service-endpoint-sp;
  83       }
  84       container path-description {
  85         uses transportpce-pathDescription:path-description;
  86       }
  87     }
  88     output {
  89        uses org-openroadm-common-service-types:configuration-response-common;
  90     }
  91   }
  92
  93   rpc service-delete {
  94     input {
  95       leaf service-name {
  96         type string;
  97         description
  98           "Identifier for the service to be created in
  99            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.";
 100         mandatory true;
 101       }
 102       uses transportpce-common-service-path-types:service-handler-header;
 103     }
 104     output {
 105          uses org-openroadm-common-service-types:configuration-response-common;
 106     }
 107   }
 108
 109 notification service-rpc-result-sp {
 110     description
 111       "This Notification indicates result of  service RPC and provides the topology";
 112     leaf notification-type {
 113       type transportpce-common-service-path-types:service-path-notification-types;
 114     }
 115     container path-topology {
 116       uses org-openroadm-topology:topology;
 117     }
 118     uses transportpce-common-service-path-types:rpc-response-status-ex;
 119     uses org-openroadm-common-service-types:service-notification-result;
 120   }
 121 }