summaryrefslogtreecommitdiffhomepage
path: root/doc/source
diff options
context:
space:
mode:
authortungyueh <tylin.cs03g@nctu.edu.tw>2016-08-25 15:53:17 +0800
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2016-09-07 09:37:46 +0900
commit1970e70a0d64d9f8b9dd36e53dc71cf6fb20fdfd (patch)
treeb4d94dad68dea4125c376bdc95cad938171be521 /doc/source
parent03e8028ce6324fef265abac03ec40471fadc1961 (diff)
add modify role API in ofctl_rest
add description about role API Signed-off-by: tungyueh <tylin.cs03g@nctu.edu.tw> Reviewed-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.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst
index 1cba2f65..c69692c5 100644
--- a/doc/source/app/ofctl_rest.rst
+++ b/doc/source/app/ofctl_rest.rst
@@ -2512,6 +2512,33 @@ Delete a meter entry
"meter_id": 1
}' http://localhost:8080/stats/meterentry/delete
+Modify role
+--------------------
+
+ modify the role of the switch.
+
+ Usage:
+
+ ======= =========================
+ Method POST
+ URI /stats/role
+ ======= =========================
+
+ Request message body:
+
+ =========== ============================ ========= =================
+ Attribute Description Example Default
+ =========== ============================ ========= =================
+ dpid Datapath ID (int) 1 (Mandatory)
+ role One of OFPCR_ROLE_*(string) "MASTER" OFPCR_ROLE_EQUAL
+ =========== ============================ ========= =================
+
+ Example of use::
+
+ $ curl -X POST -d '{
+ "dpid": 1,
+ "role": "MASTER"
+ }' http://localhost:8080/stats/role
Support for experimenter multipart
==================================