~james-page/ubuntu/saucy/openvswitch/1.12-snapshot

« back to all changes in this revision

Viewing changes to utilities/ovs-dpctl.8.in

  • Committer: James Page
  • Date: 2013-08-21 10:16:57 UTC
  • mfrom: (1.1.20)
  • Revision ID: james.page@canonical.com-20130821101657-3o0z0qeiv5zkwlzi
New upstream snapshot

Show diffs side-by-side

added added

removed removed

Lines of Context:
104
104
If one or more datapaths are specified, information on only those
105
105
datapaths are displayed.  Otherwise, \fBovs\-dpctl\fR displays information
106
106
about all configured datapaths.
 
107
.SS "DEBUGGING COMMANDS"
 
108
The following commands are primarily useful for debugging Open
 
109
vSwitch.  The flow table entries (both matches and actions) that they
 
110
work with are not OpenFlow flow entries.  Instead, they are different
 
111
and considerably simpler flows maintained by the Open vSwitch kernel
 
112
module.  Use \fBovs\-ofctl\fR(8), instead, to work with OpenFlow flow
 
113
entries.
 
114
.
 
115
.PP
 
116
The \fIdp\fR argument to each of these commands is optional when
 
117
exactly one datapath exists, in which case that datapath is the
 
118
default.  When multiple datapaths exist, then a datapath name is
 
119
required.
107
120
.
108
121
.IP "\fBdump\-flows\fR [\fIdp\fR]"
109
122
Prints to the console all flow entries in datapath \fIdp\fR's
110
 
flow table.  If \fIdp\fR is not specified and exactly one datapath
111
 
exists, the flows for that datapath will be printed.
112
 
.IP
113
 
This command is primarily useful for debugging Open vSwitch.  The flow
114
 
table entries that it displays are not
115
 
OpenFlow flow entries.  Instead, they are different and considerably
116
 
simpler flows maintained by the Open vSwitch kernel module.  If you wish
117
 
to see the OpenFlow flow entries, use \fBovs\-ofctl dump\-flows\fR.
 
123
flow table.
 
124
.
 
125
.IP "\fBadd\-flow\fR [\fIdp\fR] \fIflow actions\fR"
 
126
.IQ "[\fB\-\-clear\fR] [\fB\-\-may-create\fR] [\fB\-s\fR | \fB\-\-statistics\fR] \fBmod\-flow\fR [\fIdp\fR] \fIflow actions\fR"
 
127
Adds or modifies a flow in \fIdp\fR's flow table that, when a packet
 
128
matching \fIflow\fR arrives, causes \fIactions\fR to be executed.
 
129
.IP
 
130
The \fBadd\-flow\fR command succeeds only if \fIflow\fR does not
 
131
already exist in \fIdp\fR.  Contrariwise, \fBmod\-flow\fR without
 
132
\fB\-\-may\-create\fR only modifies the actions for an existing flow.
 
133
With \fB\-\-may\-create\fR, \fBmod\-flow\fR will add a new flow or
 
134
modify an existing one.
 
135
.IP
 
136
If \fB\-s\fR or \fB\-\-statistics\fR is specified, then
 
137
\fBmod\-flows\fR prints the modified flow's statistics.  A flow's
 
138
statistics are the number of packets and bytes that have passed
 
139
through the flow, the elapsed time since the flow last processed a
 
140
packet (if ever), and (for TCP flows) the union of the TCP flags
 
141
processed through the flow.
 
142
.IP
 
143
With \fB\-\-clear\fR, \fBmod\-flows\fR zeros out the flow's
 
144
statistics.  The statistics printed if \fB\-s\fR or
 
145
\fB\-\-statistics\fR is also specified are those from just before
 
146
clearing the statistics.
 
147
.
 
148
.IP "[\fB\-s\fR | \fB\-\-statistics\fR] \fBdel\-flow\fR [\fIdp\fR] \fIflow\fR"
 
149
Deletes the flow from \fIdp\fR's flow table that matches \fIflow\fR.
 
150
If \fB\-s\fR or \fB\-\-statistics\fR is specified, then
 
151
\fBmod\-flows\fR prints the deleted flow's statistics.
118
152
.
119
153
.IP "\fBdel\-flows\fR [\fIdp\fR]"
120
 
Deletes all flow entries from datapath \fIdp\fR's flow table.  If
121
 
\fIdp\fR is not specified and exactly one datapath exists, the flows for
122
 
that datapath will be deleted.
123
 
.IP
124
 
This command is primarily useful for debugging Open vSwitch.  As
125
 
discussed in \fBdump\-flows\fR, these entries are
126
 
not OpenFlow flow entries.  By deleting them, the process that set them
127
 
up may be confused about their disappearance.
 
154
Deletes all flow entries from datapath \fIdp\fR's flow table.
128
155
.
129
156
.SH OPTIONS
130
157
.IP "\fB\-s\fR"