Makefile.am: Clean flake8-check too.

[cascardo/ovs.git] / lib / dpctl.man

diff --git a/lib/dpctl.man b/lib/dpctl.man
index c678576..70df690 100644 (file)
--- a/lib/dpctl.man
+++ b/lib/dpctl.man
@@ -126,13 +126,13 @@ With \fB\-\-may\-create\fR, \fBmod\-flow\fR will add a new flow or
 modify an existing one.
 .IP
 If \fB\-s\fR or \fB\-\-statistics\fR is specified, then
-\fBmod\-flows\fR prints the modified flow's statistics.  A flow's
+\fBmod\-flow\fR prints the modified flow's statistics.  A flow's
 statistics are the number of packets and bytes that have passed
 through the flow, the elapsed time since the flow last processed a
 packet (if ever), and (for TCP flows) the union of the TCP flags
 processed through the flow.
 .IP
-With \fB\-\-clear\fR, \fBmod\-flows\fR zeros out the flow's
+With \fB\-\-clear\fR, \fBmod\-flow\fR zeros out the flow's
 statistics.  The statistics printed if \fB\-s\fR or
 \fB\-\-statistics\fR is also specified are those from just before
 clearing the statistics.
@@ -141,7 +141,41 @@ clearing the statistics.
 .DO "[\fB\-s\fR | \fB\-\-statistics\fR]" "\*(DX\fBdel\-flow\fR" "[\fIdp\fR] \fIflow\fR"
 Deletes the flow from \fIdp\fR's flow table that matches \fIflow\fR.
 If \fB\-s\fR or \fB\-\-statistics\fR is specified, then
-\fBmod\-flows\fR prints the deleted flow's statistics.
+\fBdel\-flow\fR prints the deleted flow's statistics.
+.
+.IP "\*(DX\fBget\-flow\fR [\fIdp\fR] ufid:\fIufid\fR"
+Fetches the flow from \fIdp\fR's flow table with unique identifier \fIufid\fR.
+\fIufid\fR must be specified as a string of 32 hexadecimal characters.
 .
 .IP "\*(DX\fBdel\-flows\fR [\fIdp\fR]"
 Deletes all flow entries from datapath \fIdp\fR's flow table.
+.SS "CONNECTION TRACKING TABLE DEBUGGING COMMANDS"
+The following commands are primarily useful for debugging the connection
+tracking entries in the datapath.
+.
+.PP
+The \fIdp\fR argument to each of these commands is optional when
+exactly one datapath exists, in which case that datapath is the
+default.  When multiple datapaths exist, then a datapath name is
+required.
+.
+.PP
+\fBN.B.\fR(Linux specific): the \fIsystem\fR datapaths (i.e. the Linux
+kernel module Open vSwitch datapaths) share a single connection tracking
+table (which is also used by other kernel subsystems, such as iptables,
+nftables and the regular host stack).  Therefore, the following commands
+do not apply specifically to one datapath.
+.
+.TP
+.DO "[\fB\-m\fR | \fB\-\-more\fR] [\fB\-s\fR | \fB\-\-statistics\fR]" "\*(DX\fBdump\-conntrack\fR" "[\fIdp\fR] [\fBzone=\fIzone\fR]"
+Prints to the console all the connection entries in the tracker used by
+\fIdp\fR.  If \fBzone=\fIzone\fR is specified, only shows the connections
+in \fBzone\fR.  With \fB\-\-more\fR, some implementation specific details
+are included. With \fB\-\-statistics\fR timeouts and timestamps are
+added to the output.
+.
+.TP
+\*(DX\fBflush\-conntrack [\fIdp\fR] [\fBzone=\fIzone\fR]
+Flushes all the connection entries in the tracker used by \fIdp\fR.
+If \fBzone=\fIzone\fR is specified, only flushes the connections in
+\fBzone\fR.