ovs-dpctl: Remove obsolete documentation of limit on number of datapaths.
[openvswitch] / utilities / ovs-dpctl.8.in
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .TH ovs\-dpctl 8 "August 2009" "Open vSwitch" "Open vSwitch Manual"
7 .ds PN ovs\-dpctl
8 .
9 .SH NAME
10 ovs\-dpctl \- administer Open vSwitch datapaths
11 .
12 .SH SYNOPSIS
13 .B ovs\-dpctl
14 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
15 .
16 .SH DESCRIPTION
17 .PP
18 The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
19 datapaths.  A single machine may host any number of datapaths.
20 .PP
21 A newly created datapath is associated with only one network device, a
22 virtual network device sometimes called the datapath's ``local port''.
23 A newly created datapath is not, however, associated with any of the
24 host's other network devices.  To intercept and process traffic on a
25 given network device, use the \fBadd\-if\fR command to explicitly add
26 that network device to the datapath.
27 .PP
28 If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
29 of \fBovs\-dpctl\fR.
30 .PP
31 Most \fBovs\-dpctl\fR commands that work with datapaths take an
32 argument that specifies the name of the datapath.  Datapath names take
33 the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
34 device associated with the datapath's local port.  If \fItype\fR is
35 given, it specifies the datapath provider of \fIname\fR, otherwise the
36 default provider \fBsystem\fR is assumed.
37 .PP
38 The following commands manage datapaths.
39 .
40 .TP
41 \fBadd\-dp \fIdp\fR [\fInetdev\fR[\fB,\fIoption\fR]...]
42 Creates datapath \fIdp\fR, with a local port also named \fIdp\fR.
43 This will fail if a network device \fIdp\fR already exists.
44 .IP
45 If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the
46 new datapath, just as if \fBadd\-if\fR was specified.
47 .
48 .TP
49 \fBdel\-dp \fIdp\fR
50 Deletes datapath \fIdp\fR.  If \fIdp\fR is associated with any network
51 devices, they are automatically removed.
52 .
53 .TP
54 \fBadd\-if \fIdp netdev\fR[\fB,\fIoption\fR]...
55 Adds each \fInetdev\fR to the set of network devices datapath
56 \fIdp\fR monitors, where \fIdp\fR is the name of an existing
57 datapath, and \fInetdev\fR is the name of one of the host's
58 network devices, e.g. \fBeth0\fR.  Once a network device has been added
59 to a datapath, the datapath has complete ownership of the network device's
60 traffic and the network device appears silent to the rest of the
61 system.
62 .IP
63 A \fInetdev\fR may be followed by a comma-separated list of options.
64 The following options are currently supported:
65 .
66 .RS
67 .IP "\fBtype=\fItype\fR"
68 Specifies the type of port to add.  The default type is \fBsystem\fR.
69 .IP "\fIkey\fB=\fIvalue\fR"
70 Adds an arbitrary key-value option to the port's configuration.
71 .RE
72 .IP
73 \fBovs\-vswitchd.conf.db\fR(5) documents the available port types and
74 options.
75 .
76 .IP "\fBset\-if \fIdp port\fR[\fB,\fIoption\fR]..."
77 Reconfigures each \fIport\fR in \fIdp\fR as specified.  An
78 \fIoption\fR of the form \fIkey\fB=\fIvalue\fR adds the specified
79 key-value option to the port or overrides an existing key's value.  An
80 \fIoption\fR of the form \fIkey\fB=\fR, that is, without a value,
81 deletes the key-value named \fIkey\fR.  The type of a port cannot be
82 changed, so \fBtype=\fItype\fR is only allowed if \fItype\fR is the
83 port's existing type.
84 .TP
85 \fBdel\-if \fIdp netdev\fR...
86 Removes each \fInetdev\fR from the list of network devices datapath
87 \fIdp\fR monitors.
88 .
89 .TP
90 \fBdump\-dps\fR
91 Prints the name of each configured datapath on a separate line.
92 .
93 .TP
94 [\fB\-s\fR | \fB\-\-statistics\fR] \fBshow \fR[\fIdp\fR...]
95 Prints a summary of configured datapaths, including their datapath
96 numbers and a list of ports connected to each datapath.  (The local
97 port is identified as port 0.)  If \fB\-s\fR or \fB\-\-statistics\fR
98 is specified, then packet and byte counters are also printed for each
99 port.
100 .IP
101 If one or more datapaths are specified, information on only those
102 datapaths are displayed.  Otherwise, \fBovs\-dpctl\fR displays information
103 about all configured datapaths.
104 .
105 .IP "\fBdump\-flows \fIdp\fR"
106 Prints to the console all flow entries in datapath \fIdp\fR's
107 flow table.
108 .IP
109 This command is primarily useful for debugging Open vSwitch.  The flow
110 table entries that it displays are not
111 OpenFlow flow entries.  Instead, they are different and considerably
112 simpler flows maintained by the Open vSwitch kernel module.
113 .IP "\fBdel\-flows \fIdp\fR"
114 Deletes all flow entries from datapath \fIdp\fR's flow table.
115 .IP
116 This command is primarily useful for debugging Open vSwitch.  As
117 discussed in \fBdump\-flows\fR, these entries are
118 not OpenFlow flow entries.  By deleting them, the process that set them
119 up may be confused about their disappearance.
120 .
121 .SH OPTIONS
122 .IP "\fB\-s\fR"
123 .IQ "\fB\-\-statistics\fR"
124 Causes the \fBshow\fR command to print packet and byte counters for
125 each port within the datapaths that it shows.
126 .
127 .IP "\fB\-t\fR"
128 .IQ "\fB\-\-timeout=\fIsecs\fR"
129 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
130 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
131 signal.
132 .
133 .so lib/vlog.man
134 .so lib/common.man
135 .
136 .SH "SEE ALSO"
137 .
138 .BR ovs\-appctl (8),
139 .BR ovs\-vswitchd (8)