utilities/ovs-dpctl.8.in

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