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>
This commit is contained in:
Yusuke Iwase 2015-01-19 10:49:08 +09:00 committed by FUJITA Tomonori
parent fe0d068f86
commit 310e20ee0b

View File

@ -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
----------------