api/src/main/yang/transportpce-portmapping@2017-02-28.yang

   1 module transportpce-portmapping {
   2   yang-version 1;
   3   namespace "http://org/opendaylight/transportpce/portmapping";
   4   prefix "org-opendaylight-transportpce-portmapping";
   5
   6   import org-openroadm-common-types {
   7     prefix org-openroadm-common-types;
   8     revision-date 2016-10-14;
   9   }
  10
  11  organization
  12     "transportPCE";
  13   contact
  14     "transportPCE committers - ODL";
  15   description
  16     "YANG definitions of RPCs supported by OLM.
  17      Copyright (c) 2017 AT&T and others.  All rights reserved.
  18      authors: Dhruv Bhardwaj ( db929a@att.com )
  19               Shweta Vachhani ( sv111y@att.com )";
  20
  21   revision "2017-02-28" {
  22     description "Initial revision of port mapping model";
  23   }
  24   container network{
  25     list nodes{
  26       key node-id;
  27       leaf node-id{
  28         type string;
  29         description
  30           "Unique identifier for node in the network";
  31       }
  32
  33       leaf openroadm-version{
  34         type enumeration {
  35           enum "1.2.1" {
  36             value 1;
  37             description
  38               "Version 1.2.1";
  39             }
  40             enum "2.2.1" {
  41               value 2;
  42               description
  43                 "Version 2.2.1";
  44             }
  45           }
  46         }
  47       leaf node-type{
  48         type org-openroadm-common-types:node-types;
  49         description
  50           "Identifier for node-type e.g Roadm, xponder";
  51       }
  52       leaf clli{
  53           type string;
  54           description
  55             "Common Language Location Identifier read from device";
  56       }
  57       list mapping{
  58         description
  59           "Mapping for Physical circuit pack/port/parent interfaces
  60           corresponding to each logical connection point present in the node.";
  61         key logical-connection-point;
  62         leaf logical-connection-point{
  63           type string;
  64         }
  65         leaf supporting-circuit-pack-name{
  66           type string;
  67           description
  68           "Circuit pack where the logical connection point is located";
  69         }
  70         leaf supporting-port{
  71           type string;
  72           description
  73           "Port where the logical connection point is located";
  74         }
  75         leaf supporting-oms{
  76           type string;
  77           description
  78           "OMS interface provisioned on the port";
  79         }
  80         leaf supporting-ots{
  81           type string;
  82           description
  83           "OTS interface provisioned on the port";
  84         }
  85         leaf port-direction{
  86           type string;
  87           description
  88             "Useful for line port of XPDR, for which there is no
  89             indication in its logical-termination-point naming";
  90         }
  91         leaf port-qual{
  92           type string;
  93           description
  94             "Useful to identify from portmapping client from network ports of XPDR";
  95         }
  96         leaf associated-lcp{
  97           type string;
  98           description
  99             "For XPDR, associate two logical-connection-points
 100             from device/connnection-map data";
 101         }
 102         leaf partner-lcp{
 103             type string;
 104             description
 105               "For XPDR unidirectional NETWORK port, associate two logical-connection-points
 106               from device/partner port data";
 107           }
 108       }
 109       list cp-to-degree{
 110         description
 111           "This mapping helps locate degree number of the circuitpack that does lldp
 112          protocol management";
 113        key circuit-pack-name;
 114        leaf circuit-pack-name{
 115           type string;
 116        }
 117        leaf degree-number{
 118             type uint32;
 119        }
 120        leaf interface-name{
 121           type string;
 122        }
 123       }
 124     }
 125   }
 126 }