utilities/ovs-dpctl.8.in

   1 .so lib/ovs.tmac
   2 .TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
   3 .ds PN ovs\-dpctl
   4 .
   5 .SH NAME
   6 ovs\-dpctl \- administer Open vSwitch datapaths
   7 .
   8 .SH SYNOPSIS
   9 .B ovs\-dpctl
  10 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
  11 .
  12 .SH DESCRIPTION
  13 .PP
  14 The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
  15 datapaths.  A single machine may host any number of datapaths.
  16 .PP
  17 This program works only with datapaths that are implemented outside of
  18 \fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
  19 datapaths.  To manage datapaths that are integrated into
  20 \fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
  21 use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
  22 are documented in \fBovs\-vswitchd\fR(8).
  23 .PP
  24 A newly created datapath is associated with only one network device, a
  25 virtual network device sometimes called the datapath's ``local port''.
  26 A newly created datapath is not, however, associated with any of the
  27 host's other network devices.  To intercept and process traffic on a
  28 given network device, use the \fBadd\-if\fR command to explicitly add
  29 that network device to the datapath.
  30 .PP
  31 If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
  32 of \fBovs\-dpctl\fR.
  33 .PP
  34 Most \fBovs\-dpctl\fR commands that work with datapaths take an
  35 argument that specifies the name of the datapath.  Datapath names take
  36 the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
  37 device associated with the datapath's local port.  If \fItype\fR is
  38 given, it specifies the datapath provider of \fIname\fR, otherwise the
  39 default provider \fBsystem\fR is assumed.
  40 .PP
  41 The following commands manage datapaths.
  42 .
  43 .ds DX
  44 .de DO
  45 \\$1 \\$2 \\$3
  46 ..
  47 .so lib/dpctl.man
  48 .
  49 .SH OPTIONS
  50 .IP "\fB\-t\fR"
  51 .IQ "\fB\-\-timeout=\fIsecs\fR"
  52 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
  53 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
  54 signal.
  55 .
  56 .so lib/vlog.man
  57 .so lib/common.man
  58 .
  59 .SH "SEE ALSO"
  60 .
  61 .BR ovs\-appctl (8),
  62 .BR ovs\-vswitchd (8)