mirrors/ryu
1
0
Fork 0
mirror of https://github.com/faucetsdn/ryu.git synced 2025-08-08 15:47:09 +02:00
Code Issues Projects Releases Wiki Activity

doc/app/ofctl_rest: Add the attribute for message

Browse Source 
This patch adds attributes of the following messages.
 - Add the port number for get ports stats.
 - Add the group id for get group stats.
 - Add the meter id for get meter stats.
 - Add the meter id for get meter config.
 - Add the port number and queue id for get queue stats.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
Shinpei Muraoka 2016-03-22 09:51:46 +09:00 committed by FUJITA Tomonori
parent 32f5c622b3
commit a1a5ff08b6
1 changed files with 45 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
doc/source/app/ofctl_rest.rst
View File

@ -632,10 +632,15 @@ Get ports stats
Usage: Usage:
======= =================== ======= ===========================
Method GET Method GET
URI /stats/port/<dpid> URI /stats/port/<dpid>[/<port>]
======= =================== ======= ===========================
.. NOTE::
Specification of port number is optional.
Response message body: Response message body:
@ -762,10 +767,20 @@ Get queues stats
Usage: Usage:
======= ==================== ======= =========================================
Method GET Method GET
URI /stats/queue/<dpid> URI /stats/queue/<dpid>[/<port>[/<queue_id>]]
======= ==================== ======= =========================================
.. NOTE::
Specification of port number and queue id are optional.
If you want to omitting the port number and setting the queue id,
please specify the keyword "ALL" to the port number.
e.g. GET http://localhost:8080/stats/queue/1/ALL/1
Response message body: Response message body:
@ -892,10 +907,15 @@ Get groups stats
Usage: Usage:
======= ==================== ======= ================================
Method GET Method GET
URI /stats/group/<dpid> URI /stats/group/<dpid>[/<group_id>]
======= ==================== ======= ================================
.. NOTE::
Specification of group id is optional.
Response message body: Response message body:
@ -1094,10 +1114,15 @@ Get meters stats
Usage: Usage:
======= ======================= ======= ================================
Method GET Method GET
URI /stats/meter/<dpid> URI /stats/meter/<dpid>[/<meter_id>]
======= ======================= ======= ================================
.. NOTE::
Specification of meter id is optional.
Response message body: Response message body:
@ -1153,10 +1178,15 @@ Get meter config stats
Usage: Usage:
======= ============================ ======= ======================================
Method GET Method GET
URI /stats/meterconfig/<dpid> URI /stats/meterconfig/<dpid>[/<meter_id>]
======= ============================ ======= ======================================
.. NOTE::
Specification of meter id is optional.
Response message body: Response message body: