ofproto: Add "ofproto/trace" command to help debugging flow tables.
[sliver-openvswitch.git] / ofproto / ofproto-unixctl.man
1 .SS "OFPROTO COMMANDS"
2 These commands manage the core OpenFlow switch implementation (called
3 \fBofproto\fR).
4 .IP "\fBofproto/list\fR"
5 Lists the names of the running ofproto instances.  These are the names
6 that may be used on \fBofproto/trace\fR.
7 .IP "\fBofproto/trace \fItun_id in_port packet\fR"
8 Traces the path of an imaginary packet through ofproto.  The arguments
9 are:
10 .RS
11 .IP "\fItun_id\fR"
12 The tunnel ID on which the packet arrived.  Use
13 \fB0\fR if the packet did not arrive through a tunnel.
14 .IP "\fIin_port\fR"
15 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
16 packet arrived on \fBOFPP_LOCAL\fR, the local port.
17 .IP "\fIpacket\fR"
18 A sequence of hex digits specifying the packet's contents.  An
19 Ethernet frame is at least 14 bytes long, so there must be at least 28
20 hex digits.  Obviously, it is inconvenient to type in the hex digits
21 by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1)
22 utilities provide easier ways.
23 .RS
24 \fB\*(PN\fR will respond with extensive information on how the packet
25 would be handled if it were to be received.  The packet will not
26 actually be sent.