ryu/doc/source/ofproto_v1_0_ref.rst

   1 *************************************
   2 OpenFlow v1.0 Messages and Structures
   3 *************************************
   4
   5 .. py:currentmodule:: ryu.ofproto.ofproto_v1_0_parser
   6
   7 Controller-to-Switch Messages
   8 =============================
   9
  10 Handshake
  11 ---------
  12
  13 .. autoclass:: OFPFeaturesRequest
  14
  15     JSON Example:
  16
  17     .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-5-features_request.packet.json
  18
  19 .. autoclass:: OFPSwitchFeatures
  20
  21     JSON Example:
  22
  23     .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-6-ofp_switch_features.packet.json
  24
  25 Switch Configuration
  26 --------------------
  27
  28 .. autoclass:: OFPSetConfig
  29
  30 ..    JSON Example:
  31 ..
  32 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-7-ofp_set_config.packet.json
  33
  34 .. autoclass:: OFPGetConfigRequest
  35
  36 ..    JSON Example:
  37 ..
  38 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-8-ofp_get_config_request.packet.json
  39
  40 .. autoclass:: OFPGetConfigReply
  41
  42 ..    JSON Example:
  43 ..
  44 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-9-ofp_get_config_reply.packet.json
  45
  46 Modify State Messages
  47 ---------------------
  48
  49 .. autoclass:: OFPFlowMod
  50
  51     JSON Example:
  52
  53     .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-2-ofp_flow_mod.packet.json
  54 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-3-ofp_flow_mod.packet.json
  55
  56 .. autoclass:: OFPPortMod
  57
  58 ..    JSON Example:
  59 ..
  60 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-22-ofp_port_mod.packet.json
  61
  62 Queue Configuration Messages
  63 ----------------------------
  64
  65 .. autoclass:: OFPQueueGetConfigRequest
  66
  67 ..    JSON Example:
  68 ..
  69 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-35-ofp_queue_get_config_request.packet.json
  70
  71 .. autoclass:: OFPQueueGetConfigReply
  72
  73 ..    JSON Example:
  74 ..
  75 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-36-ofp_queue_get_config_reply.packet.json
  76
  77 Read State Messages
  78 -------------------
  79
  80 .. autoclass:: OFPDescStatsRequest
  81
  82 ..    JSON Example:
  83 ..
  84 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-24-ofp_desc_stats_request.packet.json
  85
  86 .. autoclass:: OFPDescStatsReply
  87
  88 ..    JSON Example:
  89 ..
  90 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-0-ofp_desc_stats_reply.packet.json
  91
  92 .. autoclass:: OFPFlowStatsRequest
  93
  94 ..    JSON Example:
  95 ..
  96 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-11-ofp_flow_stats_request.packet.json
  97
  98 .. autoclass:: OFPFlowStatsReply
  99
 100 ..    JSON Example:
 101 ..
 102 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-12-ofp_flow_stats_reply.packet.json
 103
 104 .. autoclass:: OFPAggregateStatsRequest
 105
 106 ..    JSON Example:
 107 ..
 108 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-25-ofp_aggregate_stats_request.packet.json
 109
 110 .. autoclass:: OFPAggregateStatsReply
 111
 112 ..    JSON Example:
 113 ..
 114 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-26-ofp_aggregate_stats_reply.packet.json
 115
 116 .. autoclass:: OFPTableStatsRequest
 117
 118 ..    JSON Example:
 119 ..
 120 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-27-ofp_table_stats_request.packet.json
 121
 122 .. autoclass:: OFPTableStatsReply
 123
 124 ..    XXX commented out because it's too long
 125 ..    JSON Example:
 126 ..
 127 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-28-ofp_table_stats_reply.packet.json
 128
 129 .. autoclass:: OFPPortStatsRequest
 130
 131 ..    JSON Example:
 132 ..
 133 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-29-ofp_port_stats_request.packet.json
 134
 135 .. autoclass:: OFPPortStatsReply
 136
 137 ..    JSON Example:
 138 ..
 139 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-30-ofp_port_stats_reply.packet.json
 140
 141 .. autoclass:: OFPQueueStatsRequest
 142
 143 ..    JSON Example:
 144 ..
 145 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-37-ofp_queue_stats_request.packet.json
 146
 147 .. autoclass:: OFPQueueStatsReply
 148
 149 ..    JSON Example:
 150 ..
 151 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-38-ofp_queue_stats_reply.packet.json
 152
 153 .. autoclass:: OFPVendorStatsRequest
 154 .. autoclass:: OFPVendorStatsReply
 155
 156 Send Packet Message
 157 -------------------
 158
 159 .. autoclass:: OFPPacketOut
 160
 161     JSON Example:
 162
 163     .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-1-ofp_packet_out.packet.json
 164
 165 Barrier Message
 166 ---------------
 167
 168 .. autoclass:: OFPBarrierRequest
 169
 170 ..    JSON Example:
 171 ..
 172 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-17-ofp_barrier_request.packet.json
 173
 174 .. autoclass:: OFPBarrierReply
 175
 176 ..    JSON Example:
 177 ..
 178 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-18-ofp_barrier_reply.packet.json
 179
 180
 181 Asynchronous Messages
 182 =====================
 183
 184 Packet-In Message
 185 -----------------
 186
 187 .. autoclass:: OFPPacketIn
 188
 189     JSON Example:
 190
 191     .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-4-ofp_packet_in.packet.json
 192
 193 Flow Removed Message
 194 --------------------
 195
 196 .. autoclass:: OFPFlowRemoved
 197
 198 ..    JSON Example:
 199 ..
 200 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-40-ofp_flow_removed.packet.json
 201
 202 Port Status Message
 203 -------------------
 204
 205 .. autoclass:: OFPPortStatus
 206
 207 ..    JSON Example:
 208 ..
 209 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-39-ofp_port_status.packet.json
 210
 211 Error Message
 212 -------------
 213
 214 .. autoclass:: OFPErrorMsg
 215
 216 ..    JSON Example:
 217 ..
 218 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-15-ofp_error_msg.packet.json
 219 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-41-ofp_error_msg_vendor.packet.json
 220
 221 Symmetric Messages
 222 ==================
 223
 224 Hello
 225 -----
 226
 227 .. autoclass:: OFPHello
 228
 229 ..    JSON Example:
 230 ..
 231 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-10-ofp_hello.packet.json
 232
 233 Echo Request
 234 ------------
 235
 236 .. autoclass:: OFPEchoRequest
 237
 238 ..    JSON Example:
 239 ..
 240 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-13-ofp_echo_request.packet.json
 241
 242
 243 Echo Reply
 244 ----------
 245
 246 .. autoclass:: OFPEchoReply
 247
 248 ..    JSON Example:
 249 ..
 250 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-14-ofp_echo_reply.packet.json
 251
 252
 253 Vendor
 254 ------------
 255
 256 .. autoclass:: OFPVendor
 257
 258 ..    JSON Example:
 259 ..
 260 ..    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of10/1-16-ofp_vendor.packet.json
 261
 262 Port Structures
 263 ===============
 264
 265 .. autoclass:: OFPPhyPort
 266
 267
 268 Flow Match Structure
 269 ====================
 270
 271 .. autoclass:: OFPMatch
 272
 273
 274 Action Structures
 275 =================
 276
 277 .. autoclass:: OFPActionHeader
 278 .. autoclass:: OFPAction
 279 .. autoclass:: OFPActionOutput
 280 .. autoclass:: OFPActionVlanVid
 281 .. autoclass:: OFPActionVlanPcp
 282 .. autoclass:: OFPActionStripVlan
 283 .. autoclass:: OFPActionDlAddr
 284 .. autoclass:: OFPActionSetDlSrc
 285 .. autoclass:: OFPActionSetDlDst
 286 .. autoclass:: OFPActionNwAddr
 287 .. autoclass:: OFPActionSetNwSrc
 288 .. autoclass:: OFPActionSetNwDst
 289 .. autoclass:: OFPActionSetNwTos
 290 .. autoclass:: OFPActionTpPort
 291 .. autoclass:: OFPActionSetTpSrc
 292 .. autoclass:: OFPActionSetTpDst
 293 .. autoclass:: OFPActionEnqueue
 294 .. autoclass:: OFPActionVendor