utilities/ovs-dpctl.8.in

   1 .de IQ
   2 .  br
   3 .  ns
   4 .  IP "\\$1"
   5 ..
   6 .TH ovs\-dpctl 8 "@VERSION@" "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 This program works only with datapaths that are implemented outside of
  22 \fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
  23 datapaths.  To manage datapaths that are integrated into
  24 \fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
  25 use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
  26 are documented in \fBovs\-vswitchd\fR(8).
  27 .PP
  28 A newly created datapath is associated with only one network device, a
  29 virtual network device sometimes called the datapath's ``local port''.
  30 A newly created datapath is not, however, associated with any of the
  31 host's other network devices.  To intercept and process traffic on a
  32 given network device, use the \fBadd\-if\fR command to explicitly add
  33 that network device to the datapath.
  34 .PP
  35 If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
  36 of \fBovs\-dpctl\fR.
  37 .PP
  38 Most \fBovs\-dpctl\fR commands that work with datapaths take an
  39 argument that specifies the name of the datapath.  Datapath names take
  40 the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
  41 device associated with the datapath's local port.  If \fItype\fR is
  42 given, it specifies the datapath provider of \fIname\fR, otherwise the
  43 default provider \fBsystem\fR is assumed.
  44 .PP
  45 The following commands manage datapaths.
  46 .
  47 .ds DX
  48 .de DO
  49 \\$1 \\$2 \\$3
  50 ..
  51 .so lib/dpctl.man
  52 .
  53 .SH OPTIONS
  54 .IP "\fB\-s\fR"
  55 .IQ "\fB\-\-statistics\fR"
  56 Causes the \fBshow\fR command to print packet and byte counters for
  57 each port within the datapaths that it shows.
  58 .
  59 .IP "\fB\-m\fR"
  60 .IQ "\fB\-\-more\fR"
  61 Increases the verbosity of \fBdump\-flows\fR output.
  62 .
  63 .IP "\fB\-t\fR"
  64 .IQ "\fB\-\-timeout=\fIsecs\fR"
  65 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
  66 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
  67 signal.
  68 .
  69 .so lib/vlog.man
  70 .so lib/common.man
  71 .
  72 .SH "SEE ALSO"
  73 .
  74 .BR ovs\-appctl (8),
  75 .BR ovs\-vswitchd (8)