pintos-os.org Git - openvswitch/blob - 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 priority tun_id in_port packet\fR"
  10 .IQ "\fBofproto/trace \fIswitch 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 "\fIpriority\fR"
  17 Packet QoS priority. Use \fB0\fR if QoS is not setup.
  18 .IP "\fItun_id\fR"
  19 The tunnel ID on which the packet arrived.  Use
  20 \fB0\fR if the packet did not arrive through a tunnel.
  21 .IP "\fIin_port\fR"
  22 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
  23 packet arrived on \fBOFPP_LOCAL\fR, the local port.
  24 .IP "\fIpacket\fR"
  25 A sequence of hex digits specifying the packet's contents.  An
  26 Ethernet frame is at least 14 bytes long, so there must be at least 28
  27 hex digits.  Obviously, it is inconvenient to type in the hex digits
  28 by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1)
  29 utilities provide easier ways.
  30 .RE
  31 .IP
  32 The second form specifies the packet's contents implicitly:
  33 .RS
  34 .IP "\fIflow\fR"
  35 A flow in one of two forms: either the form printed by
  36 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format
  37 similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR
  38 command.  This is not an OpenFlow flow: besides other differences, it
  39 never contains wildcards.  \fB\*(PN\fR generates an arbitrary packet
  40 that has the specified \fIflow\fR.
  41 .RE
  42 .IP
  43 \fB\*(PN\fR will respond with extensive information on how the packet
  44 would be handled if it were to be received.  The packet will not
  45 actually be sent, but side effects such as MAC learning will occur.
  46 .
  47 .IP "\fBofproto/trace \fIswitch flow\fR"
  48 Traces the path of a packet in an imaginary flow through
  49 \fIswitch\fR.  The arguments are:
  50 .RS
  51 .IP "\fIswitch\fR"
  52 The switch on which the packet arrived (one of those listed by
  53 \fBofproto/list\fR).
  54 .IP "\fIflow\fR"
  55 A flow in one of two forms: either the form printed by
  56 \fBovs\-dpctl\fR(8)'s \fBdump\-flows\fR command, or in a format
  57 similar to that accepted by \fBovs\-ofctl\fR(8)'s \fBadd\-flow\fR
  58 command.  This is not an OpenFlow flow: besides other differences, it
  59 never contains wildcards.
  60 .RE
  61 .IP
  62 \fB\*(PN\fR will respond with extensive information on how a packet
  63 in \fIflow\fR would be handled if it were received by
  64 \fIswitch\fR.  No packet will actually be sent.  Some side effects may
  65 occur, but MAC learning in particular will not.
  66 .IP
  67 This form of \fBofproto/trace\fR cannot determine the complete set of
  68 datapath actions in some corner cases.  If the results say that this
  69 is the case, rerun \fBofproto/trace\fR supplying a packet in the flow
  70 to get complete results.
  71 .IP "\fBofproto/self\-check\fR [\fIswitch\fR]"
  72 Runs an internal consistency check on \fIswitch\fR, if specified,
  73 otherwise on all ofproto instances, and responds with a brief summary
  74 of the results.  If the summary reports any errors, then the Open
  75 vSwitch logs should contain more detailed information.  Please pass
  76 along errors reported by this command to the Open vSwitch developers
  77 as bugs.