doc: Add some JSON examples to openflow api reference for of1.5
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
Minoru TAKAHASHI
FUJITA Tomonori
parent
62a53a548d
commit
97906ee740
@ -12,22 +12,46 @@ Handshake
|
|||||||
|
|
||||||
.. autoclass:: OFPFeaturesRequest
|
.. autoclass:: OFPFeaturesRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-features_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPSwitchFeatures
|
.. autoclass:: OFPSwitchFeatures
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-features_reply.packet.json
|
||||||
|
|
||||||
Switch Configuration
|
Switch Configuration
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
.. autoclass:: OFPSetConfig
|
.. autoclass:: OFPSetConfig
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-set_config.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGetConfigRequest
|
.. autoclass:: OFPGetConfigRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_config_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGetConfigReply
|
.. autoclass:: OFPGetConfigReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_config_reply.packet.json
|
||||||
|
|
||||||
Modify State Messages
|
Modify State Messages
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. autoclass:: OFPTableMod
|
.. autoclass:: OFPTableMod
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_mod.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPFlowMod
|
.. autoclass:: OFPFlowMod
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -44,15 +68,31 @@ Modify State Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPPortMod
|
.. autoclass:: OFPPortMod
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_mod.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterMod
|
.. autoclass:: OFPMeterMod
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_mod.packet.json
|
||||||
|
|
||||||
Multipart Messages
|
Multipart Messages
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
.. autoclass:: OFPDescStatsRequest
|
.. autoclass:: OFPDescStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-desc_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPDescStatsReply
|
.. autoclass:: OFPDescStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-desc_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPFlowDescStatsRequest
|
.. autoclass:: OFPFlowDescStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -67,6 +107,10 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPFlowStatsRequest
|
.. autoclass:: OFPFlowStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPFlowStatsReply
|
.. autoclass:: OFPFlowStatsReply
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -75,6 +119,10 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPAggregateStatsRequest
|
.. autoclass:: OFPAggregateStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-aggregate_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPAggregateStatsReply
|
.. autoclass:: OFPAggregateStatsReply
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -83,8 +131,16 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPPortStatsRequest
|
.. autoclass:: OFPPortStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPPortStatsReply
|
.. autoclass:: OFPPortStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_stats_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPPortDescStatsRequest
|
.. autoclass:: OFPPortDescStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -93,10 +149,22 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPPortDescStatsReply
|
.. autoclass:: OFPPortDescStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_desc_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPQueueStatsRequest
|
.. autoclass:: OFPQueueStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPQueueStatsReply
|
.. autoclass:: OFPQueueStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_stats_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPQueueDescStatsRequest
|
.. autoclass:: OFPQueueDescStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -105,10 +173,22 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPQueueDescStatsReply
|
.. autoclass:: OFPQueueDescStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_desc_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGroupStatsRequest
|
.. autoclass:: OFPGroupStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGroupStatsReply
|
.. autoclass:: OFPGroupStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_stats_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGroupDescStatsRequest
|
.. autoclass:: OFPGroupDescStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -123,20 +203,52 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPGroupFeaturesStatsRequest
|
.. autoclass:: OFPGroupFeaturesStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_features_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGroupFeaturesStatsReply
|
.. autoclass:: OFPGroupFeaturesStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_features_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterStatsRequest
|
.. autoclass:: OFPMeterStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterStatsReply
|
.. autoclass:: OFPMeterStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_stats_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterDescStatsRequest
|
.. autoclass:: OFPMeterDescStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_desc_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterDescStatsReply
|
.. autoclass:: OFPMeterDescStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_desc_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterFeaturesStatsRequest
|
.. autoclass:: OFPMeterFeaturesStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_features_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPMeterFeaturesStatsReply
|
.. autoclass:: OFPMeterFeaturesStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_features_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPControllerStatusStatsRequest
|
.. autoclass:: OFPControllerStatusStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -151,12 +263,28 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPTableStatsRequest
|
.. autoclass:: OFPTableStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_stats_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPTableStatsReply
|
.. autoclass:: OFPTableStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_stats_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPTableDescStatsRequest
|
.. autoclass:: OFPTableDescStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_desc_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPTableDescStatsReply
|
.. autoclass:: OFPTableDescStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_desc_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPTableFeaturesStatsRequest
|
.. autoclass:: OFPTableFeaturesStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -171,8 +299,16 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPFlowMonitorRequest
|
.. autoclass:: OFPFlowMonitorRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_monitor_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPFlowMonitorReply
|
.. autoclass:: OFPFlowMonitorReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_monitor_reply.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPBundleFeaturesStatsRequest
|
.. autoclass:: OFPBundleFeaturesStatsRequest
|
||||||
|
|
||||||
JSON Example:
|
JSON Example:
|
||||||
@ -187,8 +323,16 @@ Multipart Messages
|
|||||||
|
|
||||||
.. autoclass:: OFPExperimenterStatsRequest
|
.. autoclass:: OFPExperimenterStatsRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-experimenter_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPExperimenterStatsReply
|
.. autoclass:: OFPExperimenterStatsReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-experimenter_reply.packet.json
|
||||||
|
|
||||||
Packet-Out Message
|
Packet-Out Message
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
@ -203,8 +347,16 @@ Barrier Message
|
|||||||
|
|
||||||
.. autoclass:: OFPBarrierRequest
|
.. autoclass:: OFPBarrierRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-barrier_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPBarrierReply
|
.. autoclass:: OFPBarrierReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-barrier_reply.packet.json
|
||||||
|
|
||||||
Role Request Message
|
Role Request Message
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
@ -240,10 +392,22 @@ Set Asynchronous Configuration Message
|
|||||||
|
|
||||||
.. autoclass:: OFPSetAsync
|
.. autoclass:: OFPSetAsync
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-set_async.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGetAsyncRequest
|
.. autoclass:: OFPGetAsyncRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_async_request.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPGetAsyncReply
|
.. autoclass:: OFPGetAsyncReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_async_reply.packet.json
|
||||||
|
|
||||||
Asynchronous Messages
|
Asynchronous Messages
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
@ -270,21 +434,37 @@ Port Status Message
|
|||||||
|
|
||||||
.. autoclass:: OFPPortStatus
|
.. autoclass:: OFPPortStatus
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_status.packet.json
|
||||||
|
|
||||||
Controller Role Status Message
|
Controller Role Status Message
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
.. autoclass:: OFPRoleStatus
|
.. autoclass:: OFPRoleStatus
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-role_status.packet.json
|
||||||
|
|
||||||
Table Status Message
|
Table Status Message
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
.. autoclass:: OFPTableStatus
|
.. autoclass:: OFPTableStatus
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_status.packet.json
|
||||||
|
|
||||||
Request Forward Message
|
Request Forward Message
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
.. autoclass:: OFPRequestForward
|
.. autoclass:: OFPRequestForward
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-requestforward.packet.json
|
||||||
|
|
||||||
Controller Status Message
|
Controller Status Message
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
@ -302,6 +482,10 @@ Hello
|
|||||||
|
|
||||||
.. autoclass:: OFPHello
|
.. autoclass:: OFPHello
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-hello.packet.json
|
||||||
|
|
||||||
.. autoclass:: OFPHelloElemVersionBitmap
|
.. autoclass:: OFPHelloElemVersionBitmap
|
||||||
|
|
||||||
Echo Request
|
Echo Request
|
||||||
@ -309,21 +493,37 @@ Echo Request
|
|||||||
|
|
||||||
.. autoclass:: OFPEchoRequest
|
.. autoclass:: OFPEchoRequest
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-echo_request.packet.json
|
||||||
|
|
||||||
Echo Reply
|
Echo Reply
|
||||||
----------
|
----------
|
||||||
|
|
||||||
.. autoclass:: OFPEchoReply
|
.. autoclass:: OFPEchoReply
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-echo_reply.packet.json
|
||||||
|
|
||||||
Error Message
|
Error Message
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
.. autoclass:: OFPErrorMsg
|
.. autoclass:: OFPErrorMsg
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-error_msg.packet.json
|
||||||
|
|
||||||
Experimenter
|
Experimenter
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. autoclass:: OFPExperimenter
|
.. autoclass:: OFPExperimenter
|
||||||
|
|
||||||
|
JSON Example:
|
||||||
|
|
||||||
|
.. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-error_msg_experimenter.packet.json
|
||||||
|
|
||||||
Flow Match Structure
|
Flow Match Structure
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user