api/src/main/yang/transportpce-portmapping@2020-04-29.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 2018-10-19;
   9   }
  10   import org-openroadm-switching-pool-types {
  11     prefix org-openroadm-switching-pool-types;
  12     revision-date 2017-12-15;
  13   }
  14   import org-openroadm-port-types {
  15     prefix org-openroadm-port-types;
  16     revision-date 2018-10-19;
  17   }
  18   import ietf-inet-types {
  19     prefix ietf-inet-types;
  20     revision-date 2013-07-15;
  21   }
  22
  23   organization
  24     "transportPCE";
  25   contact
  26     "transportPCE committers - ODL";
  27   description
  28     "YANG definitions of RPCs supported by OLM. Copyright (c) 2017
  29      AT&T and others. All rights reserved. authors: Dhruv Bhardwaj
  30      ( db929a@att.com ) Shweta Vachhani ( sv111y@att.com )";
  31
  32   revision 2020-04-29 {
  33     description
  34       "Add SAPI/DAPI lcp hash value";
  35   }
  36   revision 2020-01-28 {
  37     description
  38       "Add necessary parameters to consolidate OTN
  39        and address ONAP MDONS use case";
  40   }
  41   revision 2020-01-13 {
  42     description
  43       "Add OTN data from device and necessary
  44        to build node inside otn topology";
  45   }
  46   revision 2019-11-15 {
  47     description
  48       "OTN support";
  49   }
  50   revision 2019-07-02 {
  51     description
  52       "Version 2. To manage device 2.2.1";
  53   }
  54   revision 2017-02-28 {
  55     description
  56       "Initial revision of port mapping model";
  57   }
  58
  59   container network {
  60     list nodes {
  61       key "node-id";
  62       leaf node-id {
  63         type string;
  64         description
  65           "Unique identifier for node in the network";
  66       }
  67       container node-info {
  68         leaf node-type {
  69           type org-openroadm-common-types:node-types;
  70           description
  71             "Identifier for node-type e.g Roadm, xponder";
  72         }
  73         leaf openroadm-version {
  74           type enumeration {
  75             enum 1.2.1 {
  76               value 1;
  77               description
  78                 "Version 1.2.1";
  79             }
  80             enum 2.2.1 {
  81               value 2;
  82               description
  83                 "Version 2.2.1";
  84             }
  85           }
  86         }
  87         leaf node-clli {
  88           type string;
  89           description
  90             "Common Language Location Identifier.";
  91         }
  92         leaf node-vendor {
  93           type string;
  94           description
  95             "Vendor of the equipment";
  96         }
  97         leaf node-model {
  98           type string;
  99           description
 100             "Physical resource model information.";
 101         }
 102         leaf node-ip-address {
 103           type ietf-inet-types:ip-address;
 104           description
 105             "Current IP Address of device";
 106         }
 107       }
 108       list mapping {
 109         key "logical-connection-point";
 110         description
 111           "Mapping for Physical circuit pack/port/parent interfaces corresponding
 112            to each logical connection point present in the node.";
 113         leaf logical-connection-point {
 114           type string;
 115         }
 116         leaf supporting-circuit-pack-name {
 117           type string;
 118           description
 119             "Circuit pack where the logical connection point is located";
 120         }
 121         leaf supporting-port {
 122           type string;
 123           description
 124             "Port where the logical connection point is located";
 125         }
 126         leaf supporting-oms {
 127           type string;
 128           description
 129             "OMS interface provisioned on the port";
 130         }
 131         leaf supporting-ots {
 132           type string;
 133           description
 134             "OTS interface provisioned on the port";
 135         }
 136         leaf port-direction {
 137           type string;
 138           description
 139             "Useful for line port of XPDR, for which there is no indication
 140              in its logical-termination-point naming";
 141         }
 142         leaf port-qual {
 143           type string;
 144           description
 145             "Useful to identify from portmapping client from network ports
 146              of XPDR";
 147         }
 148         leaf supporting-ethernet {
 149           type string;
 150           description
 151             "Ethernet interface provisioned on the port";
 152         }
 153         leaf supporting-odu4 {
 154           type string;
 155           description
 156             "ODU4 interface provisioned on the port";
 157         }
 158         leaf rate {
 159           type string;
 160           description
 161             "Rate supported by the port";
 162         }
 163         leaf-list supported-interface-capability {
 164           type identityref {
 165             base org-openroadm-port-types:supported-if-capability;
 166           }
 167         }
 168         leaf xponder-type {
 169           type org-openroadm-common-types:xpdr-node-types;
 170         }
 171         leaf connection-map-lcp {
 172           type string;
 173           description
 174             "For XPDR, associate two logical-connection-points from device/connnection-map
 175              data";
 176         }
 177         leaf partner-lcp {
 178           type string;
 179           description
 180             "For XPDR unidirectional NETWORK port, associate two logical-connection-points
 181              from device/partner port data";
 182         }
 183         leaf lcp-hash-val {
 184           type string;
 185           description
 186             "Hash value generated from node-id and lcp. This value will be used to map-
 187             back SAPI and DAPI resource";
 188         }
 189       }
 190       list cp-to-degree {
 191         key "circuit-pack-name";
 192         description
 193           "This mapping helps locate degree number of the circuitpack that
 194            does lldp protocol management";
 195         leaf circuit-pack-name {
 196           type string;
 197         }
 198         leaf degree-number {
 199           type uint32;
 200         }
 201         leaf interface-name {
 202           type string;
 203         }
 204       }
 205       list switching-pool-lcp {
 206         key "switching-pool-number";
 207         description
 208           "For MUXPDR and SWITCH, associates from device/odu-switching-pools data, the logical-connection-points";
 209         leaf switching-pool-number {
 210           type uint16;
 211           description
 212             "Unique identifier for this odu-switching-pool";
 213         }
 214         leaf switching-pool-type {
 215           type org-openroadm-switching-pool-types:switching-pool-types;
 216         }
 217         list non-blocking-list {
 218           key "nbl-number";
 219           leaf nbl-number {
 220             type uint16;
 221             description
 222               "Identifier for this non-blocking-list. Unique within odu-switching-pool";
 223           }
 224           leaf interconnect-bandwidth-unit {
 225             type uint32;
 226             description
 227               "Switch fabric interconnect bandwidth unit rate in bits per second.
 228                Represents granularity of switch fabric";
 229           }
 230           leaf interconnect-bandwidth {
 231             type uint32;
 232             description
 233               "Total interconnect bandwidth for a non-blocking element expressed as
 234                number of inter-connect-bandwidth units : corresponds to capable-
 235                inter-connect bandwidth";
 236           }
 237           leaf available-interconnect-bandwidth {
 238             type uint32;
 239             description
 240               "Total interconnect bandwidth available for a non-blocking element can use as
 241                number of inter-connect-bandwidth units";
 242           }
 243           leaf-list lcp-list {
 244             type string;
 245           }
 246         }
 247       }
 248     }
 249   }
 250 }