diff options
| author | Shinpei Muraoka <shinpei.muraoka@gmail.com> | 2016-04-12 11:33:36 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2016-05-16 15:02:40 +0900 |
| commit | f351cd39779b496be60e9c3bcb8fc6355dad5e89 (patch) | |
| tree | 555cdb52b7ed63a8ca18d5ade98fabf6ed03f8ba /doc/source | |
| parent | 918edd4effbfd4d2b3b9b24cdb7324b99ebf4201 (diff) | |
doc/app/ofctl_rest: Update the optional parameter of the message
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@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 | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst index 55b1c2e7..52016194 100644 --- a/doc/source/app/ofctl_rest.rst +++ b/doc/source/app/ofctl_rest.rst @@ -1157,10 +1157,14 @@ Get queues config Usage: - ======= ================================ + ======= ================================== Method GET - URI /stats/queueconfig/<dpid>/<port> - ======= ================================ + URI /stats/queueconfig/<dpid>/[<port>] + ======= ================================== + + .. NOTE:: + + Specification of port number is optional. .. CAUTION:: @@ -1236,10 +1240,20 @@ Get queues description Usage: - ======= ========================================= + ======= ============================================= Method GET - URI /stats/queuedesc/<dpid>/<port>/<queue_id> - ======= ========================================= + URI /stats/queuedesc/<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/queuedesc/1/ALL/1 + .. CAUTION:: |