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 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 .ds DX
  41 .de DO
  42 \\$1 \\$2 \\$3
  43 ..
  44 .so lib/dpctl.man
  45 .
  46 .SH OPTIONS
  47 .IP "\fB\-s\fR"
  48 .IQ "\fB\-\-statistics\fR"
  49 Causes the \fBshow\fR command to print packet and byte counters for
  50 each port within the datapaths that it shows.
  51 .
  52 .IP "\fB\-m\fR"
  53 .IQ "\fB\-\-more\fR"
  54 Increases the verbosity of \fBdump\-flows\fR output.
  55 .
  56 .IP "\fB\-t\fR"
  57 .IQ "\fB\-\-timeout=\fIsecs\fR"
  58 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
  59 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
  60 signal.
  61 .
  62 .so lib/vlog.man
  63 .so lib/common.man
  64 .
  65 .SH "SEE ALSO"
  66 .
  67 .BR ovs\-appctl (8),
  68 .BR ovs\-vswitchd (8)