diff options
| author | Yusuke Iwase <iwase.yusuke0@gmail.com> | 2015-01-19 10:49:08 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-01-20 13:12:48 +0900 |
| commit | 310e20ee0be49a606c519cb6f70bc650385159a3 (patch) | |
| tree | 241893953145fdace803c3fab38e2e55baced717 /doc/source | |
| parent | fe0d068f868b3a5e609519220933cd90f39d963e (diff) | |
doc/app/ofctl_rest: Add description for OFPQueueStats message
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')
| -rw-r--r-- | doc/source/app/ofctl_rest.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst index 3437e444..81baa968 100644 --- a/doc/source/app/ofctl_rest.rst +++ b/doc/source/app/ofctl_rest.rst @@ -355,6 +355,63 @@ Get ports description } +Get queues stats +---------------- + + Get queues stats of the switch which specified with Datapath ID in URI. + + Usage: + + ======= ==================== + Method GET + URI /stats/queue/<dpid> + ======= ==================== + + Response message body: + + ============== ============================================================= =========== + Attribute Description Example + ============== ============================================================= =========== + dpid Datapath ID "1" + port_no Port number 1 + queue_id Queue ID 0 + tx_bytes Number of transmitted bytes 0 + tx_packets Number of transmitted packets 0 + tx_errors Number of packets dropped due to overrun 0 + duration_sec Time queue has been alive in seconds 4294963425 + duration_nsec Time queue has been alive in nanoseconds beyond duration_sec 3912967296 + ============== ============================================================= =========== + + Example of use:: + + $ curl -X GET http://localhost:8080/stats/queue/1 + + :: + + { + "1": [ + { + "port_no": 1, + "queue_id": 0, + "tx_bytes": 0, + "tx_packets": 0, + "tx_errors": 0, + "duration_sec": 4294963425, + "duration_nsec": 3912967296 + }, + { + "port_no": 1, + "queue_id": 1, + "tx_bytes": 0, + "tx_packets": 0, + "tx_errors": 0, + "duration_sec": 4294963425, + "duration_nsec": 3912967296 + } + ] + } + + Get groups stats ---------------- |