diff options
| author | Minoru TAKAHASHI <takahashi.minoru7@gmail.com> | 2015-10-22 17:31:37 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-10-28 14:44:41 +0900 |
| commit | 58cb365755c4a154196adbe18fad54f630a9e1f6 (patch) | |
| tree | 82ab58b8fd22e89d154f2aaced8bf5990ae95039 /doc | |
| parent | ec55ca5756c178b9af4dabc9b0b8666588677b5f (diff) | |
doc/app/ofctl_rest: Add description for OFPQueueGetConfig message
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/app/ofctl_rest.rst | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst index 823752fd..95a12351 100644 --- a/doc/source/app/ofctl_rest.rst +++ b/doc/source/app/ofctl_rest.rst @@ -593,6 +593,79 @@ Get queues stats } +Get queues config +----------------- + + Get queues config of the switch which specified with Datapath ID and Port in URI. + + Usage: + + ======= ================================ + Method GET + URI /stats/queueconfig/<dpid>/<port> + ======= ================================ + + Response message body: + + ================ ====================================================== ======================================== + Attribute Description Example + ================ ====================================================== ======================================== + dpid Datapath ID "1" + port Port which was queried 1 + queues struct ofp_packet_queue + -- queue_id ID for the specific queue 2 + -- port Port this queue is attached to 0 + -- properties struct ofp_queue_prop_header properties [{"property": "MIN_RATE","rate": 80}] + ================ ====================================================== ======================================== + + Example of use:: + + $ curl -X GET http://localhost:8080/stats/queueconfig/1/1 + + :: + + { + "1": [ + { + "port": 1, + "queues": [ + { + "properties": [ + { + "property": "MIN_RATE", + "rate": 80 + } + ], + "port": 0, + "queue_id": 1 + }, + { + "properties": [ + { + "property": "MAX_RATE", + "rate": 120 + } + ], + "port": 2, + "queue_id": 2 + }, + { + "properties": [ + { + "property": "EXPERIMENTER", + "data": [], + "experimenter": 999 + } + ], + "port": 3, + "queue_id": 3 + } + ] + } + ] + } + + Get groups stats ---------------- |