summaryrefslogtreecommitdiffhomepage
path: root/doc/source/app/ofctl_rest.rst
diff options
context:
space:
mode:
authorYusuke Iwase <iwase.yusuke0@gmail.com>2014-12-05 09:31:19 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2014-12-05 10:00:58 +0900
commit567ff4ec170296144f66605eb8a6a8730a34e9a0 (patch)
treea436207866d8e8cfe8e362d05b434fb9e3042778 /doc/source/app/ofctl_rest.rst
parent9ecfa8f3be7c52196db00cb47d8f4169174f023f (diff)
doc/app/ofctl_rest: Add description for capabilities field in OPFMeterFeatures
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc/source/app/ofctl_rest.rst')
-rw-r--r--doc/source/app/ofctl_rest.rst26
1 files changed, 16 insertions, 10 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst
index 973448b7..1b9170fd 100644
--- a/doc/source/app/ofctl_rest.rst
+++ b/doc/source/app/ofctl_rest.rst
@@ -681,15 +681,16 @@ Get meter features stats
Response message body:
- =========== ============================================ =========
- Attribute Description Example
- =========== ============================================ =========
- dpid Datapath ID "1"
- max_meter Maximum number of meters 256
- band_types Bitmaps of (1 << OFPMBT_*) values supported ['DROP']
- max_bands Maximum bands per meters 16
- max_color Maximum color value 8
- =========== ============================================ =========
+ ============= ============================================ ===========================
+ Attribute Description Example
+ ============= ============================================ ===========================
+ dpid Datapath ID "1"
+ max_meter Maximum number of meters 256
+ band_types Bitmaps of (1 << OFPMBT_*) values supported ["DROP"]
+ capabilities Bitmaps of "ofp_meter_flags" ["KBPS", "BURST", "STATS"]
+ max_bands Maximum bands per meters 16
+ max_color Maximum color value 8
+ ============= ============================================ ===========================
Example of use::
@@ -702,7 +703,12 @@ Get meter features stats
{
"max_meter": 256,
"band_types": [
- 'DROP'
+ "DROP"
+ ],
+ "capabilities": [
+ "KBPS",
+ "BURST",
+ "STATS"
],
"max_bands": 16,
"max_color": 8