utilities/ovs-dpctl.8.in

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