ofproto: Rename "private.h" to "ofproto->provider.h".
[openvswitch] / 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 \fIswitch tun_id in_port packet\fR"
8 Traces the path of an imaginary packet through \fIswitch\fR.  The
9 arguments are:
10 .RS
11 .IP "\fIswitch\fR"
12 The switch on which the packet arrived (one of those listed by
13 \fBofproto/list\fR).
14 .IP "\fItun_id\fR"
15 The tunnel ID on which the packet arrived.  Use
16 \fB0\fR if the packet did not arrive through a tunnel.
17 .IP "\fIin_port\fR"
18 The OpenFlow port on which the packet arrived.  Use \fB65534\fR if the
19 packet arrived on \fBOFPP_LOCAL\fR, the local port.
20 .IP "\fIpacket\fR"
21 A sequence of hex digits specifying the packet's contents.  An
22 Ethernet frame is at least 14 bytes long, so there must be at least 28
23 hex digits.  Obviously, it is inconvenient to type in the hex digits
24 by hand, so the \fBovs\-pcap\fR(1) and \fBovs\-tcpundump\fR(1)
25 utilities provide easier ways.
26 .RE
27 \fB\*(PN\fR will respond with extensive information on how the packet
28 would be handled if it were to be received.  The packet will not
29 actually be sent.