ofproto/ofproto-unixctl.man

   1 .SS "OFPROTO COMMANDS"
   2 These commands manage the core OpenFlow switch implementation (called
   3 \fBofproto\fR).
   4 .
   5 .IP "\fBofproto/list\fR"
   6 Lists the names of the running ofproto instances.  These are the names
   7 that may be used on \fBofproto/trace\fR.
   8 .
   9 .IP "\fBofproto/trace \fIswitch tun_id in_port packet\fR"
  10 .IQ "\fBofproto/trace \fIswitch odp_flow \fB\-generate\fR"
  11 Traces the path of an imaginary packet through \fIswitch\fR.  Both
  12 forms require \fIswitch\fR, the switch on which the packet arrived
  13 (one of those listed by \fBofproto/list\fR).  The first form specifies
  14 a packet's contents explicitly:
  15 .RS
  16 .IP "\fItun_id\fR"
  17 The tunnel ID on which the packet arrived.  Use
  18 \fB0\fR if the packet did not arrive through a tunnel.
  19 .IP "\fIin_port\fR"
  20 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
  21 packet arrived on \fBOFPP_LOCAL\fR, the local port.
  22 .IP "\fIpacket\fR"
  23 A sequence of hex digits specifying the packet's contents.  An
  24 Ethernet frame is at least 14 bytes long, so there must be at least 28
  25 hex digits.  Obviously, it is inconvenient to type in the hex digits
  26 by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1)
  27 utilities provide easier ways.
  28 .RE
  29 .IP
  30 The second form specifies the packet's contents implicitly:
  31 .RS
  32 .IP "\fIodp_flow\fR"
  33 A flow in the form printed by \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR
  34 command.  This is not an OpenFlow flow: besides other differences, it
  35 never contains wildcards.  \fB\*(PN\fR generates an arbitrary packet
  36 that has the specified \fIodp_flow\fR.
  37 .RE
  38 .IP
  39 \fB\*(PN\fR will respond with extensive information on how the packet
  40 would be handled if it were to be received.  The packet will not
  41 actually be sent, but side effects such as MAC learning will occur.
  42 .
  43 .IP "\fBofproto/trace \fIswitch odp_flow\fR"
  44 Traces the path of a packet in an imaginary flow through
  45 \fIswitch\fR.  The arguments are:
  46 .RS
  47 .IP "\fIswitch\fR"
  48 The switch on which the packet arrived (one of those listed by
  49 \fBofproto/list\fR).
  50 .IP "\fIodp_flow\fR"
  51 A flow in the form printed by \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR
  52 command.  This is not an OpenFlow flow: besides other differences, it
  53 never contains wildcards.
  54 .RE
  55 .IP
  56 \fB\*(PN\fR will respond with extensive information on how a packet
  57 in \fIodp_flow\fR would be handled if it were received by
  58 \fIswitch\fR.  No packet will actually be sent.  Some side effects may
  59 occur, but MAC learning in particular will not.
  60 .IP
  61 This form of \fBofproto/trace\fR cannot determine the complete set of
  62 datapath actions in some corner cases.  If the results say that this
  63 is the case, rerun \fBofproto/trace\fR supplying a packet in the flow
  64 to get complete results.