.TH ovs\-dpctl 8 "August 2009" "Open vSwitch" "Open vSwitch Manual"
.ds PN ovs\-dpctl
-
+.
.SH NAME
ovs\-dpctl \- administer Open vSwitch datapaths
-
+.
.SH SYNOPSIS
.B ovs\-dpctl
[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
-
+.
.SH DESCRIPTION
-
+.PP
The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
datapaths. A single machine may host up to 256 datapaths (numbered 0
to 255).
-
+.PP
A newly created datapath is associated with only one network device, a
virtual network device sometimes called the datapath's ``local port''.
A newly created datapath is not, however, associated with any of the
host's other network devices. To intercept and process traffic on a
given network device, use the \fBadd\-if\fR command to explicitly add
that network device to the datapath.
-
-Do not use \fBovs\-dpctl\fR commands to modify datapaths if
-\fBovs\-vswitchd\fR(8) is in use. Instead, modify the
-\fBovs\-vswitchd\fR configuration file and send \fBSIGHUP\fR to the
-\fBovs\-vswitchd\fR process.
-
.PP
-Most \fBovs\-dpctl\fR commands that work with datapaths take an argument
-that specifies the name of the datapath, in one of the following
-forms:
-
-.so lib/dpif.man
-
+If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
+of \fBovs\-dpctl\fR.
+.PP
+Most \fBovs\-dpctl\fR commands that work with datapaths take an
+argument that specifies the name of the datapath. Datapath names take
+the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
+device associated with the datapath's local port. If \fItype\fR is
+given, it specifies the datapath provider of \fIname\fR, otherwise the
+default provider \fBsystem\fR is assumed.
.PP
The following commands manage datapaths.
-
+.
.TP
-\fBadd\-dp \fIdp\fR [\fInetdev\fR...]
-
-Creates datapath \fIdp\fR. The name of the new datapath's local port
-depends on how \fIdp\fR is specified: if it takes the form
-\fBdp\fIN\fR, the local port will be named \fBdp\fIN\fR; otherwise,
-the local port's name will be \fIdp\fR.
-
-This will fail if the host already has 256 datapaths, if a network
-device with the same name as the new datapath's local port already
-exists, or if \fIdp\fR is given in the form \fBdp\fIN\fR
-and a datapath numbered \fIN\fR already exists.
-
-If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the datapath.
-
+\fBadd\-dp \fIdp\fR [\fInetdev\fR[\fB,\fIoption\fR]...]
+Creates datapath \fIdp\fR, with a local port also named \fIdp\fR.
+This will fail if a network device \fIdp\fR already exists.
+.IP
+If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the
+new datapath, just as if \fBadd\-if\fR was specified.
+.
.TP
\fBdel\-dp \fIdp\fR
Deletes datapath \fIdp\fR. If \fIdp\fR is associated with any network
devices, they are automatically removed.
-
+.
.TP
-\fBadd\-if \fIdp netdev\fR[\fIoption\fR...]...
+\fBadd\-if \fIdp netdev\fR[\fB,\fIoption\fR]...
Adds each \fInetdev\fR to the set of network devices datapath
\fIdp\fR monitors, where \fIdp\fR is the name of an existing
datapath, and \fInetdev\fR is the name of one of the host's
to a datapath, the datapath has complete ownership of the network device's
traffic and the network device appears silent to the rest of the
system.
-
+.IP
A \fInetdev\fR may be followed by a comma-separated list of options.
The following options are currently supported:
-
+.
.RS
-.IP "\fBinternal\fR"
-Instead of attaching an existing \fInetdev\fR, creates an internal
-port (analogous to the local port) with that name.
+.IP "\fBtype=\fItype\fR"
+Specifies the type of port to add. The default type is \fBsystem\fR.
+.IP "\fIkey\fB=\fIvalue\fR"
+Adds an arbitrary key-value option to the port's configuration.
.RE
-
+.IP
+\fBovs\-vswitchd.conf.db\fR(5) documents the available port types and
+options.
+.
+.IP "\fBset\-if \fIdp port\fR[\fB,\fIoption\fR]..."
+Reconfigures each \fIport\fR in \fIdp\fR as specified. An
+\fIoption\fR of the form \fIkey\fB=\fIvalue\fR adds the specified
+key-value option to the port or overrides an existing key's value. An
+\fIoption\fR of the form \fIkey\fB=\fR, that is, without a value,
+deletes the key-value named \fIkey\fR. The type of a port cannot be
+changed, so \fBtype=\fItype\fR is only allowed if \fItype\fR is the
+port's existing type.
.TP
\fBdel\-if \fIdp netdev\fR...
Removes each \fInetdev\fR from the list of network devices datapath
\fIdp\fR monitors.
-
+.
.TP
-\fBdump-dps\fR
+\fBdump\-dps\fR
Prints the name of each configured datapath on a separate line.
-
+.
.TP
-\fBshow \fR[\fIdp\fR...]
+[\fB\-s\fR | \fB\-\-statistics\fR] \fBshow \fR[\fIdp\fR...]
Prints a summary of configured datapaths, including their datapath
numbers and a list of ports connected to each datapath. (The local
-port is identified as port 0.)
-
+port is identified as port 0.) If \fB\-s\fR or \fB\-\-statistics\fR
+is specified, then packet and byte counters are also printed for each
+port.
+.IP
If one or more datapaths are specified, information on only those
datapaths are displayed. Otherwise, \fBovs\-dpctl\fR displays information
about all configured datapaths.
-
-.IP "\fBdump-flows \fIdp\fR"
+.
+.IP "\fBdump\-flows \fIdp\fR"
Prints to the console all flow entries in datapath \fIdp\fR's
flow table.
-
+.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 Open vSwitch kernel module.
-
-.IP "\fBdel-flows \fIdp\fR"
+.IP "\fBdel\-flows \fIdp\fR"
Deletes all flow entries from datapath \fIdp\fR's flow table.
-
+.IP
This command is primarily useful for debugging Open vSwitch. As
-discussed in \fBdump-flows\fR, these entries are
+discussed in \fBdump\-flows\fR, these entries are
not OpenFlow flow entries. By deleting them, the process that set them
up may be confused about their disappearance.
-
-.IP "\fBdump-groups \fIdp\fR"
-Prints to the console the sets of port groups maintained by datapath
-\fIdp\fR. Ordinarily there are at least 2 port groups in a datapath
-that \fBovs\-openflowd\fR or \fBovs\-vswitch\fR is controlling: group
-0 contains
-all ports except those disabled by STP, and group 1 contains all
-ports. Additional or different groups might be used in the future.
-
-This command is primarily useful for debugging Open vSwitch. OpenFlow
-does not have a concept of port groups.
-
+.
.SH OPTIONS
+.IP "\fB\-s\fR, \fB\-\-statistics\fR"
+Causes the \fBshow\fR command to print packet and byte counters for
+each port within the datapaths that it shows.
.TP
-\fB-t\fR, \fB--timeout=\fIsecs\fR
+\fB\-t\fR, \fB\-\-timeout=\fIsecs\fR
Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
signal.
-
+.
.so lib/vlog.man
.so lib/common.man
-
-.SH EXAMPLES
-
-A typical \fBovs\-dpctl\fR command sequence for controlling an
-Open vSwitch kernel module:
-
-.TP
-\fBovs\-dpctl add\-dp dp0\fR
-Creates datapath number 0.
-
-.TP
-\fBovs\-dpctl add\-if dp0 eth0 eth1\fR
-Adds two network devices to the new datapath.
-
-.PP
-At this point one would ordinarily start \fBovs\-openflowd\fR(8) on
-\fBdp0\fR, transforming \fBdp0\fR into an OpenFlow switch. Then, when
-the switch and the datapath is no longer needed:
-
-.TP
-\fBovs\-dpctl del\-if dp0 eth0 eth1\fR
-Removes network devices from the datapath.
-
-.TP
-\fBovs\-dpctl del\-dp dp0\fR
-Deletes the datapath.
-
+.
.SH "SEE ALSO"
-
+.
.BR ovs\-appctl (8),
-.BR ovs\-openflowd (8),
.BR ovs\-vswitchd (8)
git://git.onelab.eu / sliver-openvswitch.git / blobdiff