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 Do not use \fBovs\-dpctl\fR commands to modify datapaths if
  25 \fBovs\-vswitchd\fR(8) is in use.  Instead, modify the
  26 \fBovs\-vswitchd\fR configuration file and send \fBSIGHUP\fR to the
  27 \fBovs\-vswitchd\fR process.
  28 .PP
  29 Most \fBovs\-dpctl\fR commands that work with datapaths take an argument
  30 that specifies the name of the datapath, in one of the following
  31 forms:
  32 .so lib/dpif.man
  33 .PP
  34 The following commands manage datapaths.
  35 .
  36 .TP
  37 \fBadd\-dp \fIdp\fR [\fInetdev\fR...]
  38 Creates datapath \fIdp\fR.  The name of the new datapath's local port
  39 depends on how \fIdp\fR is specified: if it takes the form
  40 \fBdp\fIN\fR, the local port will be named \fBdp\fIN\fR; otherwise,
  41 the local port's name will be \fIdp\fR.
  42 .IP
  43 This will fail if the host already has 256 datapaths, if a network
  44 device with the same name as the new datapath's local port already
  45 exists, or if \fIdp\fR is given in the form \fBdp\fIN\fR
  46 and a datapath numbered \fIN\fR already exists.
  47 .IP
  48 If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the datapath.
  49 .
  50 .TP
  51 \fBdel\-dp \fIdp\fR
  52 Deletes datapath \fIdp\fR.  If \fIdp\fR is associated with any network
  53 devices, they are automatically removed.
  54 .
  55 .TP
  56 \fBadd\-if \fIdp netdev\fR[\fIoption\fR...]...
  57 Adds each \fInetdev\fR to the set of network devices datapath
  58 \fIdp\fR monitors, where \fIdp\fR is the name of an existing
  59 datapath, and \fInetdev\fR is the name of one of the host's
  60 network devices, e.g. \fBeth0\fR.  Once a network device has been added
  61 to a datapath, the datapath has complete ownership of the network device's
  62 traffic and the network device appears silent to the rest of the
  63 system.
  64 .IP
  65 A \fInetdev\fR may be followed by a comma-separated list of options.
  66 The following options are currently supported:
  67 .
  68 .RS
  69 .IP "\fBinternal\fR"
  70 Instead of attaching an existing \fInetdev\fR, creates an internal
  71 port (analogous to the local port) with that name.
  72 .RE
  73 .
  74 .TP
  75 \fBdel\-if \fIdp netdev\fR...
  76 Removes each \fInetdev\fR from the list of network devices datapath
  77 \fIdp\fR monitors.
  78 .
  79 .TP
  80 \fBdump-dps\fR
  81 Prints the name of each configured datapath on a separate line.
  82 .
  83 .TP
  84 \fBshow \fR[\fIdp\fR...]
  85 Prints a summary of configured datapaths, including their datapath
  86 numbers and a list of ports connected to each datapath.  (The local
  87 port is identified as port 0.)
  88 .IP
  89 If one or more datapaths are specified, information on only those
  90 datapaths are displayed.  Otherwise, \fBovs\-dpctl\fR displays information
  91 about all configured datapaths.
  92 .
  93 .IP "\fBdump-flows \fIdp\fR"
  94 Prints to the console all flow entries in datapath \fIdp\fR's
  95 flow table.
  96 .IP
  97 This command is primarily useful for debugging Open vSwitch.  The flow
  98 table entries that it displays are not
  99 OpenFlow flow entries.  Instead, they are different and considerably
 100 simpler flows maintained by the Open vSwitch kernel module.
 101 .IP "\fBdel-flows \fIdp\fR"
 102 Deletes all flow entries from datapath \fIdp\fR's flow table.
 103 .IP
 104 This command is primarily useful for debugging Open vSwitch.  As
 105 discussed in \fBdump-flows\fR, these entries are
 106 not OpenFlow flow entries.  By deleting them, the process that set them
 107 up may be confused about their disappearance.
 108 .
 109 .IP "\fBdump-groups \fIdp\fR"
 110 Prints to the console the sets of port groups maintained by datapath
 111 \fIdp\fR.  Ordinarily there are at least 2 port groups in a datapath
 112 that \fBovs\-openflowd\fR or \fBovs\-vswitch\fR is controlling: group
 113 0 contains
 114 all ports except those disabled by STP, and group 1 contains all
 115 ports.  Additional or different groups might be used in the future.
 116 .IP
 117 This command is primarily useful for debugging Open vSwitch.  OpenFlow
 118 does not have a concept of port groups.
 119 .SH OPTIONS
 120 .TP
 121 \fB-t\fR, \fB--timeout=\fIsecs\fR
 122 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
 123 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
 124 signal.
 125 .
 126 .so lib/vlog.man
 127 .so lib/common.man
 128 .
 129 .SH EXAMPLES
 130 .
 131 A typical \fBovs\-dpctl\fR command sequence for controlling an
 132 Open vSwitch kernel module:
 133 .
 134 .TP
 135 \fBovs\-dpctl add\-dp dp0\fR
 136 Creates datapath number 0.
 137 .
 138 .TP
 139 \fBovs\-dpctl add\-if dp0 eth0 eth1\fR
 140 Adds two network devices to the new datapath.
 141 .
 142 .PP
 143 At this point one would ordinarily start \fBovs\-openflowd\fR(8) on
 144 \fBdp0\fR, transforming \fBdp0\fR into an OpenFlow switch.  Then, when
 145 the switch and the datapath is no longer needed:
 146 .
 147 .TP
 148 \fBovs\-dpctl del\-if dp0 eth0 eth1\fR
 149 Removes network devices from the datapath.
 150 .
 151 .TP
 152 \fBovs\-dpctl del\-dp dp0\fR
 153 Deletes the datapath.
 154 .
 155 .SH "SEE ALSO"
 156 .
 157 .BR ovs\-appctl (8),
 158 .BR ovs\-openflowd (8),
 159 .BR ovs\-vswitchd (8)