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     typedef meter-ref {
 116         type instance-identifier;
 117     }
 118
 119     grouping meter {
 120
 121         leaf flags {
 122            type meter-flags;
 123         }
 124
 125         leaf meter-id {
 126             type meter-id;
 127         }
 128
 129         leaf install {
 130             type boolean;
 131         }
 132         leaf meter-name {
 133             type string;
 134         }
 135
 136         leaf container-name {
 137             type string;
 138         }
 139
 140         container meter-band-headers {
 141             list meter-band-header {
 142                 key "band-id";
 143                 leaf band-id {
 144                     type band-id;
 145                 }
 146
 147                 container meter-band-types {
 148                     leaf flags {
 149                         type meter-band-type;
 150                     }
 151                 }
 152
 153                 leaf rate {
 154                     type uint32;
 155                 }
 156
 157                 leaf burst-size {
 158                     type uint32;
 159                 }
 160                 uses band-type;
 161             }
 162         }
 163     }
 164
 165     grouping meter-statistics {
 166
 167         leaf meter-id {
 168             type meter-id;
 169         }
 170
 171         leaf flow-count {
 172             type yang:counter32;
 173         }
 174
 175         leaf packet-in-count {
 176             type yang:counter64;
 177         }
 178
 179         leaf byte-in-count {
 180             type yang:counter64;
 181         }
 182
 183         container duration {
 184             leaf second {
 185                 type yang:counter32;
 186             }
 187             leaf nanosecond {
 188                 type yang:counter32;
 189             }
 190         }
 191
 192         container meter-band-stats {
 193             list band-stat {
 194                 key "band-id";
 195                 leaf band-id {
 196                     type band-id;
 197                 }
 198
 199                 leaf packet-band-count {
 200                     type yang:counter64;
 201                 }
 202
 203                 leaf byte-band-count {
 204                     type yang:counter64;
 205                 }
 206             }
 207         }
 208     }
 209
 210     grouping meter-features {
 211
 212         leaf max_meter {
 213             type yang:counter32;
 214         }
 215
 216         leaf-list meter-band-supported {
 217                 type identityref {
 218                         base meter-band;
 219                 }
 220                 }
 221
 222         leaf-list meter-capabilities-supported {
 223                 type identityref {
 224                         base meter-capability;
 225                 }
 226                 }
 227
 228         leaf max_bands {
 229             type uint8;
 230         }
 231
 232         leaf max_color {
 233             type uint8;
 234         }
 235     }
 236
 237     grouping meter-stats-config-request {
 238         list meter-stats {
 239             key "meter-id";
 240             leaf meter-id {
 241                 type meter-id;
 242             }
 243         }
 244     }
 245
 246     grouping meter-statistics-reply {
 247         list meter-stats {
 248             key "meter-id";
 249             uses meter-statistics;
 250         }
 251     }
 252
 253     grouping meter-config-stats-reply {
 254         list meter-config-stats {
 255             key "meter-id";
 256             uses meter;
 257         }
 258     }
 259
 260     grouping meter-features-reply {
 261         uses meter-features;
 262     }
 263
 264 }