sdnr/northbound/CMNotify/model/src/main/yang/CM-NOTIFY-API.yang

   1 module CM-NOTIFY-API {
   2
   3     namespace "org:onap:ccsdk";
   4
   5     prefix cm-notify-api;
   6
   7     revision "2020-02-24" {
   8         description
   9         "CM Notification API";
  10     }
  11
  12     grouping cm-notification-response {
  13       leaf response-code {
  14         type string;
  15       }
  16       leaf response-message {
  17         type string;
  18       }
  19       description
  20         "Response payload for CM Notify RPC's";
  21     }
  22
  23     grouping x-0005b9-lte-g {
  24       leaf phy-cell-id-in-use {
  25         type uint64;
  26         default 0;
  27       }
  28       leaf pnf-name {
  29         type string {
  30           length "0..256";
  31         }
  32         description
  33           "PNF name ";
  34       }
  35     }
  36
  37     grouping lte-ran-neighbor-list-in-use-lte-cell-g {
  38       description
  39         "Table containing the LTE EUTRA (i.e. intra-RAT) cell list.";
  40       leaf plmnid {
  41         type string {
  42           length "0..6";
  43         }
  44         description
  45           "PLMN ID consists of Mobile Country Code (MCC) and Mobile Network Code (MNC) {{bibref|3GPP-TS.23.003}}, {{bibref|3GPP-TS.24.008}}. Mobile Country Code consists of three digits and uniquely identifies the country of domicile of the subscriber. Mobile Network Code consists of two or three digits and identifies the Home PLMN within a country. For a 2-digit MNC the total string length of {{param}} is 5.";
  46         reference "BBF TR-196 2.0.3 full - FAPService.{i}.CellConfig.LTE.RAN.NeighborListInUse.LTECell.{i}.PLMNID";
  47       }
  48       leaf cid {
  49          type string {
  50            length "0..52";
  51         }
  52         description
  53           "Cell Identity. {{bibref|3GPP-TS.36.331|Section 6.3.4}}. Combination of {{param|PLMNID}} and {{param}} constitutes the Cell Global ID (CGI).";
  54         reference "BBF TR-196 2.0.3 full - FAPService.{i}.CellConfig.LTE.RAN.NeighborListInUse.LTECell.{i}.CID";
  55       }
  56
  57       leaf phy-cell-id {
  58         type uint64 {
  59           range "0..503";
  60         }
  61         description
  62           "Physical cell ID, as specified in {{bibref|3GPP-TS.36.211|Section 6.11}}.";
  63         reference "BBF TR-196 2.0.3 full - FAPService.{i}.CellConfig.LTE.RAN.NeighborListInUse.LTECell.{i}.PhyCellID";
  64       }
  65       leaf pnf-name {
  66         type string {
  67           length "0..256";
  68         }
  69         description
  70           "PNF name ";
  71       }
  72       leaf blacklisted {
  73         type boolean;
  74         description
  75           "Indicates whether this neighbor cell is allowed for UEs as handover target or not. If {{true}}, handover is prohibited towards this cell. If {{false}}, handover is allowed toward this cell. The {{param}} parameter allows this cell to be prohibited as a handover target, while still allowing this cell to be included in the BCCH SIB4 or 5.";
  76         reference "BBF TR-196 2.0.3 full - FAPService.{i}.CellConfig.LTE.RAN.NeighborListInUse.LTECell.{i}.Blacklisted";
  77       }
  78
  79       reference "BBF TR-196 2.0.3 full - FAPService.{i}.CellConfig.LTE.RAN.NeighborListInUse.LTECell.{i}.";
  80     }
  81
  82
  83     rpc nbrlist-change-notification {
  84       description
  85         "RAN Neighbor List change notification to configure RuntimeDB";
  86          input {
  87              leaf fap-service-number-of-entries-changed {
  88                type uint64;
  89                description
  90                  "Number of cells for which neighbor list has changed";
  91              }
  92              list fap-service {
  93                key "alias";
  94                leaf alias {
  95                  type string {
  96                    length "1..64";
  97                  }
  98                }
  99                leaf cid {
 100                  type string {
 101                  length "0..52";
 102                  }
 103                }
 104                uses x-0005b9-lte-g;
 105                leaf lte-cell-number-of-entries {
 106                  type uint64;
 107                  description
 108                    "Number of cells in a neighbor list that was changed";
 109                }
 110                list lte-ran-neighbor-list-in-use-lte-cell-changed {
 111                  key "plmnid cid";
 112                  uses lte-ran-neighbor-list-in-use-lte-cell-g;
 113                  description
 114                    "Changed/Modified List of cells in a neighbor list for this fap service";
 115              }
 116            }
 117         }
 118
 119         output {
 120             uses cm-notification-response;
 121         }
 122     }
 123 }