diff options
| author | Minoru TAKAHASHI <takahashi.minoru7@gmail.com> | 2015-10-22 17:31:36 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-10-28 14:44:41 +0900 |
| commit | ec55ca5756c178b9af4dabc9b0b8666588677b5f (patch) | |
| tree | 557e3d0ff6d38432b9986359f4d5e33ec04bdb7e /doc | |
| parent | 6518654a1b393707250694bc0350c30069f44a22 (diff) | |
doc/app/ofctl_rest: Add description for OFPTableFeaturesStats message
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@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 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/source/app/ofctl_rest.rst b/doc/source/app/ofctl_rest.rst index 93aa1184..823752fd 100644 --- a/doc/source/app/ofctl_rest.rst +++ b/doc/source/app/ofctl_rest.rst @@ -324,6 +324,88 @@ Get aggregate flow stats filtered by fields } +Get table features +------------------ + + Get table features of the switch which specified with Datapath ID in URI. + + Usage: + + ======= =========================== + Method GET + URI /stats/tablefeatures/<dpid> + ======= =========================== + + Response message body: + + ============== ==================================== ======================================================= + Attribute Description Example + ============== ==================================== ======================================================= + dpid Datapath ID "1" + table_id Table ID 0 + name Name of Table "table_0" + metadata_match Bits of metadata table can match 18446744073709552000 + metadata_write Bits of metadata table can write 18446744073709552000 + config Bitmap of OFPTC_* values 0 + max_entries Max number of entries supported 4096 + properties struct ofp_table_feature_prop_header [{"type": "INSTRUCTIONS","instruction_ids": [...]},...] + ============== ==================================== ======================================================= + + Example of use:: + + $ curl -X GET http://localhost:8080/stats/tablefeatures/1 + + :: + + { + "1": [ + { + "metadata_write": 18446744073709552000, + "config": 0, + "table_id": 0, + "metadata_match": 18446744073709552000, + "max_entries": 4096, + "properties": [ + { + "type": "INSTRUCTIONS", + "instruction_ids": [ + { + "len": 4, + "type": 1 + }, + ... + ] + }, + ... + ], + "name": "table_0" + }, + { + "metadata_write": 18446744073709552000, + "config": 0, + "table_id": 1, + "metadata_match": 18446744073709552000, + "max_entries": 4096, + "properties": [ + { + "type": "INSTRUCTIONS", + "instruction_ids": [ + { + "len": 4, + "type": 1 + }, + ... + ] + }, + ... + ], + "name": "table_1" + }, + ... + ] + } + + Get ports stats --------------- |