diff options
| author | Shinpei Muraoka <shinpei.muraoka@gmail.com> | 2016-03-22 09:51:46 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2016-03-23 22:44:08 +0900 |
| commit | a1a5ff08b62f356d77cf539dc3bbdf03133ded6f (patch) | |
| tree | cbc4e138484873b70e6bdc72dc9df96333cfe52b /doc | |
| parent | 32f5c622b3de0ffde6d5f0a3a0ecec8c17d71083 (diff) | |
doc/app/ofctl_rest: Add the attribute for message
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/app/ofctl_rest.rst | 60 |
1 files changed, 45 insertions, 15 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst index 67f8511c..706061c6 100644 --- a/doc/source/app/ofctl_rest.rst +++ b/doc/source/app/ofctl_rest.rst @@ -632,10 +632,15 @@ Get ports stats Usage: - ======= =================== + ======= =========================== Method GET - URI /stats/port/<dpid> - ======= =================== + URI /stats/port/<dpid>[/<port>] + ======= =========================== + + .. NOTE:: + + Specification of port number is optional. + Response message body: @@ -762,10 +767,20 @@ Get queues stats Usage: - ======= ==================== + ======= ========================================= 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: @@ -892,10 +907,15 @@ Get groups stats Usage: - ======= ==================== + ======= ================================ Method GET - URI /stats/group/<dpid> - ======= ==================== + URI /stats/group/<dpid>[/<group_id>] + ======= ================================ + + .. NOTE:: + + Specification of group id is optional. + Response message body: @@ -1094,10 +1114,15 @@ Get meters stats Usage: - ======= ======================= + ======= ================================ Method GET - URI /stats/meter/<dpid> - ======= ======================= + URI /stats/meter/<dpid>[/<meter_id>] + ======= ================================ + + .. NOTE:: + + Specification of meter id is optional. + Response message body: @@ -1153,10 +1178,15 @@ Get meter config stats Usage: - ======= ============================ + ======= ====================================== Method GET - URI /stats/meterconfig/<dpid> - ======= ============================ + URI /stats/meterconfig/<dpid>[/<meter_id>] + ======= ====================================== + + .. NOTE:: + + Specification of meter id is optional. + Response message body: |