os-ken/doc/source/ofproto_v1_2_ref.rst

OpenFlow v1.2 Messages and Structures

Controller-to-Switch Messages

Handshake

OFPFeaturesRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-5-ofp_features_request.packet.json

OFPSwitchFeatures

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-6-ofp_features_reply.packet.json

Switch Configuration

OFPSetConfig

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-7-ofp_set_config.packet.json

OFPGetConfigRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-8-ofp_get_config_request.packet.json

OFPGetConfigReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-9-ofp_get_config_reply.packet.json

Flow Table Configuration

OFPTableMod

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-23-ofp_table_mod.packet.json

Modify State Messages

OFPFlowMod

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-2-ofp_flow_mod.packet.json

../../ryu/tests/unit/ofproto/json/of12/3-3-ofp_flow_mod.packet.json

OFPGroupMod

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-21-ofp_group_mod.packet.json

OFPPortMod

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-22-ofp_port_mod.packet.json

Read State Messages

OFPDescStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-24-ofp_desc_stats_request.packet.json

OFPDescStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-0-ofp_desc_stats_reply.packet.json

OFPFlowStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-11-ofp_flow_stats_request.packet.json

OFPFlowStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-12-ofp_flow_stats_reply.packet.json

OFPAggregateStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-25-ofp_aggregate_stats_request.packet.json

OFPAggregateStatsReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-26-ofp_aggregate_stats_reply.packet.json

OFPTableStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-27-ofp_table_stats_request.packet.json

OFPTableStats

OFPPortStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-29-ofp_port_stats_request.packet.json

OFPPortStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-30-ofp_port_stats_reply.packet.json

OFPQueueStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-37-ofp_queue_stats_request.packet.json

OFPQueueStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-38-ofp_queue_stats_reply.packet.json

OFPGroupStatsRequest

OFPGroupStats

OFPGroupDescStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-33-ofp_group_desc_stats_request.packet.json

OFPGroupDescStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-34-ofp_group_desc_stats_reply.packet.json

OFPGroupFeaturesStatsRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-31-ofp_group_features_stats_request.packet.json

OFPGroupFeaturesStats

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-32-ofp_group_features_stats_reply.packet.json

Queue Configuration Messages

OFPQueueGetConfigRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-35-ofp_queue_get_config_request.packet.json

OFPQueueGetConfigReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-36-ofp_queue_get_config_reply.packet.json

Packet-Out Message

OFPPacketOut

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-1-ofp_packet_out.packet.json

Barrier Message

OFPBarrierRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-17-ofp_barrier_request.packet.json

OFPBarrierReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-18-ofp_barrier_reply.packet.json

Role Request Message

OFPRoleRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-19-ofp_role_request.packet.json

OFPRoleReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-20-ofp_role_reply.packet.json

Asynchronous Messages

Packet-In Message

OFPPacketIn

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-4-ofp_packet_in.packet.json

Flow Removed Message

OFPFlowRemoved

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-40-ofp_flow_removed.packet.json

Port Status Message

OFPPortStatus

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-39-ofp_port_status.packet.json

Error Message

OFPErrorMsg

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-15-ofp_error_msg.packet.json

../../ryu/tests/unit/ofproto/json/of12/3-41-ofp_error_msg_experimenter.packet.json

Symmetric Messages

Hello

OFPHello

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-10-ofp_hello.packet.json

Echo Request

OFPEchoRequest

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-13-ofp_echo_request.packet.json

Echo Reply

OFPEchoReply

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-14-ofp_echo_reply.packet.json

Experimenter

OFPExperimenter

JSON Example:

../../ryu/tests/unit/ofproto/json/of12/3-16-ofp_experimenter.packet.json

Flow Match Structure

OFPMatch

Flow Instruction Structures

OFPInstructionGotoTable

OFPInstructionWriteMetadata

OFPInstructionActions

Action Structures

OFPActionOutput

OFPActionGroup

OFPActionSetQueue

OFPActionSetMplsTtl

OFPActionDecMplsTtl

OFPActionSetNwTtl

OFPActionDecNwTtl

OFPActionCopyTtlOut

OFPActionCopyTtlIn

OFPActionPushVlan

OFPActionPushMpls

OFPActionPopVlan

OFPActionPopMpls

OFPActionSetField

OFPActionExperimenter