opendaylight/md-sal/model/model-flow-base/src/main/yang/meter-types.yang

   1 module opendaylight-meter-types {
   2     namespace "urn:opendaylight:meter:types";
   3     prefix meter;
   4
   5     import ietf-inet-types {prefix inet; revision-date "2010-09-24";}
   6     import ietf-yang-types {prefix yang; revision-date "2010-09-24";}
   7
   8
   9     revision "2013-09-18" {
  10         description "Initial revision of meter service";
  11     }
  12
  13     typedef meter-id {
  14         type uint32;
  15     }
  16     typedef band-id {
  17         type uint32;
  18     }
  19
  20     typedef meter-flags {
  21         type bits {
  22             bit meter-kbps;
  23             bit meter-pktps;
  24             bit meter-burst;
  25             bit meter-stats;
  26         }
  27     }
  28
  29     identity meter-capability {
  30         description "Base identity for all the supported meter capabilities/flags";
  31     }
  32     identity meter-kbps {
  33         base meter-capability;
  34         description "Rate value in kb/s (kilo-bit per second)";
  35     }
  36     identity meter-pktps {
  37         base meter-capability;
  38         description "Rate value in packet/sec.";
  39     }
  40     identity meter-burst {
  41         base meter-capability;
  42         description "Do burst size.";
  43     }
  44     identity meter-stats {
  45         base meter-capability;
  46         description "Collect statistics.";
  47     }
  48
  49     typedef meter-band-type {
  50         type bits {
  51             bit ofpmbt-drop;
  52             bit ofpmbt-dscp-remark;
  53             bit ofpmbt-experimenter;
  54         }
  55     }
  56
  57     identity meter-band {
  58         description "Base identity for all the band type available";
  59     }
  60     identity meter-band-drop {
  61         base meter-band;
  62         description "Drop packet";
  63     }
  64     identity meter-band-dscp-remark {
  65         base meter-band;
  66         description "Remark DSCP in the IP header";
  67     }
  68     identity meter-band-experimenter {
  69         base meter-band;
  70         description "Experimenter meter band";
  71     }
  72
  73     grouping band-type {
  74         choice band-type {
  75             case drop {
  76                 leaf rate {
  77                     type uint32;
  78                 }
  79
  80                 leaf burst-size {
  81                     type uint32;
  82                 }
  83             }
  84
  85             case dscp-remark {
  86                 leaf rate {
  87                     type uint32;
  88                 }
  89
  90                 leaf burst-size {
  91                     type uint32;
  92                 }
  93
  94                 leaf perc_level {
  95                     type uint8;
  96                 }
  97             }
  98
  99             case experimenter {
 100                 leaf rate {
 101                     type uint32;
 102                 }
 103
 104                 leaf burst-size {
 105                     type uint32;
 106                 }
 107
 108                 leaf experimenter {
 109                     type uint32;
 110                 }
 111             }
 112         }
 113     }
 114
 115     grouping meter {
 116
 117         leaf flags {
 118            type meter-flags;
 119         }
 120
 121         leaf meter-id {
 122             type meter-id;
 123         }
 124
 125         leaf install {
 126             type boolean;
 127         }
 128         leaf meter-name {
 129             type string;
 130         }
 131
 132         leaf container-name {
 133             type string;
 134         }
 135
 136         container meter-band-headers {
 137             list meter-band-header {
 138                 key "band-id";
 139                 leaf band-id {
 140                     type band-id;
 141                 }
 142
 143                 container meter-band-types {
 144                     leaf flags {
 145                         type meter-band-type;
 146                     }
 147                 }
 148
 149                 leaf rate {
 150                     type uint32;
 151                 }
 152
 153                 leaf burst-size {
 154                     type uint32;
 155                 }
 156                 uses band-type;
 157             }
 158         }
 159     }
 160
 161     grouping meter-statistics {
 162
 163         leaf meter-id {
 164             type meter-id;
 165         }
 166
 167         leaf flow-count {
 168             type yang:counter32;
 169         }
 170
 171         leaf packet-in-count {
 172             type yang:counter64;
 173         }
 174
 175         leaf byte-in-count {
 176             type yang:counter64;
 177         }
 178
 179         container duration {
 180             leaf second {
 181                 type yang:counter32;
 182             }
 183             leaf nanosecond {
 184                 type yang:counter32;
 185             }
 186         }
 187
 188         container meter-band-stats {
 189             list band-stat {
 190                 key "band-id";
 191                 leaf band-id {
 192                     type band-id;
 193                 }
 194
 195                 leaf packet-band-count {
 196                     type yang:counter64;
 197                 }
 198
 199                 leaf byte-band-count {
 200                     type yang:counter64;
 201                 }
 202             }
 203         }
 204     }
 205
 206     grouping meter-features {
 207
 208         leaf max_meter {
 209             type yang:counter32;
 210         }
 211
 212         leaf-list meter-band-supported {
 213                 type identityref {
 214                         base meter-band;
 215                 }
 216                 }
 217
 218         leaf-list meter-capabilities-supported {
 219                 type identityref {
 220                         base meter-capability;
 221                 }
 222                 }
 223
 224         leaf max_bands {
 225             type uint8;
 226         }
 227
 228         leaf max_color {
 229             type uint8;
 230         }
 231     }
 232
 233     grouping meter-stats-config-request {
 234         list meter-stats {
 235             key "meter-id";
 236             leaf meter-id {
 237                 type meter-id;
 238             }
 239         }
 240     }
 241
 242     grouping meter-statistics-reply {
 243         list meter-stats {
 244             key "meter-id";
 245             uses meter-statistics;
 246         }
 247     }
 248
 249     grouping meter-config-stats-reply {
 250         list meter-config-stats {
 251             key "meter-id";
 252             uses meter;
 253         }
 254     }
 255
 256     grouping meter-features-reply {
 257         uses meter-features;
 258     }
 259
 260 }