[mirror_ovs.git] / ofproto / ofproto-dpif-unixctl.man

.SS "DATAPATH DEBUGGING COMMANDS"
These commands query and modify datapaths.  They are are similar to
\fBovs\-dpctl\fR(8) commands.  \fBdpif/show\fR has the additional
functionality, beyond \fBdpctl/show\fR of printing OpenFlow port
numbers.  The other commands are redundant and will be removed in a
future release.
.
.IP "\fBdpif/dump\-dps\fR"
Prints the name of each configured datapath on a separate line.
.
.IP "\fBdpif/show\fR"
Prints a summary of configured datapaths, including statistics and a
list of connected ports.  The port information includes the OpenFlow
port number, datapath port number, and the type.  (The local port is
identified as OpenFlow port 65534.)
.
.IP "\fBdpif/dump\-flows\fR [\fB\-m\fR] \fIdp\fR"
Prints to the console all flow entries in datapath \fIdp\fR's
flow table. Without \fB\-m\fR, output omits match fields that a flow
wildcards entirely; with \fB\-m\fR output includes all wildcarded fields.
.IP
This command is primarily useful for debugging Open vSwitch.  The flow
table entries that it displays are not OpenFlow flow entries.  Instead,
they are different and considerably simpler flows maintained by the
datapath module.  If you wish to see the OpenFlow flow entries, use
\fBovs\-ofctl dump\-flows\fR.
.
.IP "\fBdpif/del\-flows \fIdp\fR"
Deletes all flow entries from datapath \fIdp\fR's flow table and
underlying datapath implementation (e.g., kernel datapath module).
.IP
This command is primarily useful for debugging Open vSwitch.  As
discussed in \fBdpif/dump\-flows\fR, these entries are
not OpenFlow flow entries.
Commit	Line	Data
fceef209 DDP	1	.SS "DATAPATH DEBUGGING COMMANDS"
	2	These commands query and modify datapaths. They are are similar to
	3	\fBovs\-dpctl\fR(8) commands. \fBdpif/show\fR has the additional
	4	functionality, beyond \fBdpctl/show\fR of printing OpenFlow port
	5	numbers. The other commands are redundant and will be removed in a
	6	future release.
27022416 JP	7	.
	8	.IP "\fBdpif/dump\-dps\fR"
	9	Prints the name of each configured datapath on a separate line.
	10	.
dc54ef36	11	.IP "\fBdpif/show\fR"
27022416 JP	12	Prints a summary of configured datapaths, including statistics and a
	13	list of connected ports. The port information includes the OpenFlow
	14	port number, datapath port number, and the type. (The local port is
	15	identified as OpenFlow port 65534.)
27022416	16	.
04b541df	17	.IP "\fBdpif/dump\-flows\fR [\fB\-m\fR] \fIdp\fR"
27022416	18	Prints to the console all flow entries in datapath \fIdp\fR's
04b541df GS	19	flow table. Without \fB\-m\fR, output omits match fields that a flow
04b541df GS	20	wildcards entirely; with \fB\-m\fR output includes all wildcarded fields.
27022416 JP	21	.IP
	22	This command is primarily useful for debugging Open vSwitch. The flow
	23	table entries that it displays are not OpenFlow flow entries. Instead,
	24	they are different and considerably simpler flows maintained by the
	25	datapath module. If you wish to see the OpenFlow flow entries, use
	26	\fBovs\-ofctl dump\-flows\fR.
	27	.
	28	.IP "\fBdpif/del\-flows \fIdp\fR"
	29	Deletes all flow entries from datapath \fIdp\fR's flow table and
	30	underlying datapath implementation (e.g., kernel datapath module).
	31	.IP
	32	This command is primarily useful for debugging Open vSwitch. As
	33	discussed in \fBdpif/dump\-flows\fR, these entries are
	34	not OpenFlow flow entries.