utilities/ovs-openflowd.8.in

   1 .TH ovs\-openflowd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
   2 .ds PN ovs\-openflowd
   3
   4 .SH NAME
   5 ovs\-openflowd \- OpenFlow switch implementation
   6
   7 .SH SYNOPSIS
   8 .B ovs\-openflowd
   9 [\fIoptions\fR] \fIdatapath\fR [\fIcontroller\fR]
  10
  11 .SH DESCRIPTION
  12 The \fBovs\-openflowd\fR program implements an OpenFlow switch using a
  13 flow-based datapath.  \fBovs\-openflowd\fR connects to an OpenFlow controller
  14 over TCP or SSL.
  15
  16 The mandatory \fIdatapath\fR argument argument specifies the local datapath
  17 to relay.  It takes one of the following forms:
  18
  19 .so lib/dpif.man
  20
  21 .PP
  22 The optional \fIcontroller\fR argument specifies how to connect to
  23 the OpenFlow controller.  It takes one of the following forms:
  24 .
  25 .so lib/vconn-active.man
  26 .
  27 .PP
  28 If \fIcontroller\fR is omitted, \fBovs\-openflowd\fR attempts to discover the
  29 location of the controller automatically (see below).
  30
  31 .SS "Contacting the Controller"
  32 The OpenFlow switch must be able to contact the OpenFlow controller
  33 over the network.  It can do so in one of two ways:
  34
  35 .IP out-of-band
  36 In this configuration, OpenFlow traffic uses a network separate from
  37 the data traffic that it controls, that is, the switch does not use
  38 any of the network devices added to the datapath with \fBovs\-dpctl
  39 add\-if\fR in its communication with the controller.
  40
  41 To use \fBovs\-openflowd\fR in a network with out-of-band control, specify
  42 \fB--out-of-band\fR on the \fBovs\-openflowd\fR command line.  The control
  43 network must be configured separately, before or after \fBovs\-openflowd\fR
  44 is started.
  45
  46 .IP in-band
  47 In this configuration, a single network is used for OpenFlow traffic
  48 and other data traffic, that is, the switch contacts the controller
  49 over one of the network devices added to the datapath with \fBovs\-dpctl
  50 add\-if\fR.  This configuration is often more convenient than
  51 out-of-band control, because it is not necessary to maintain two
  52 independent networks.
  53
  54 In-band control is the default for \fBovs\-openflowd\fR, so no special
  55 command-line option is required.
  56
  57 With in-band control, the location of the controller can be configured
  58 manually or discovered automatically:
  59
  60 .RS
  61 .IP "controller discovery"
  62 To make \fBovs\-openflowd\fR discover the location of the controller
  63 automatically, do not specify the location of the controller on the
  64 \fBovs\-openflowd\fR command line.
  65
  66 In this mode, \fBovs\-openflowd\fR will broadcast a DHCP request with vendor
  67 class identifier \fBOpenFlow\fR across the network devices added to
  68 the datapath with \fBovs\-dpctl add\-if\fR.  It will accept any valid DHCP
  69 reply that has the same vendor class identifier and includes a
  70 vendor-specific option with code 1 whose contents are a string
  71 specifying the location of the controller in the same format used on
  72 the \fBovs\-openflowd\fR command line (e.g. \fBssl:192.168.0.1\fR).
  73
  74 The DHCP reply may also, optionally, include a vendor-specific option
  75 with code 2 whose contents are a string specifying the URI to the base
  76 of the OpenFlow PKI (e.g. \fBhttp://192.168.0.1/openflow/pki\fR).
  77 This URI is used only for bootstrapping the OpenFlow PKI at initial
  78 switch setup; \fBovs\-openflowd\fR does not use it at all.
  79
  80 The following ISC DHCP server configuration file assigns the IP
  81 address range 192.168.0.20 through 192.168.0.30 to OpenFlow switches
  82 that follow the switch protocol and addresses 192.168.0.1 through
  83 192.168.0.10 to all other DHCP clients:
  84
  85 default-lease-time 600;
  86 .br
  87 max-lease-time 7200;
  88 .br
  89 option space openflow;
  90 .br
  91 option openflow.controller-vconn code 1 = text;
  92 .br
  93 option openflow.pki-uri code 2 = text;
  94 .br
  95 class "OpenFlow" {
  96 .br
  97   match if option vendor-class-identifier = "OpenFlow";
  98 .br
  99   vendor-option-space openflow;
 100 .br
 101   option openflow.controller-vconn "tcp:192.168.0.10";
 102 .br
 103   option openflow.pki-uri "http://192.168.0.10/openflow/pki";
 104 .br
 105   option vendor-class-identifier "OpenFlow";
 106 .br
 107 }
 108 .br
 109 subnet 192.168.0.0 netmask 255.255.255.0 {
 110 .br
 111     pool {
 112 .br
 113         allow members of "OpenFlow";
 114 .br
 115         range 192.168.0.20 192.168.0.30;
 116 .br
 117     }
 118 .br
 119     pool {
 120 .br
 121         deny members of "OpenFlow";
 122 .br
 123         range 192.168.0.1 192.168.0.10;
 124 .br
 125     }
 126 .br
 127 }
 128 .br
 129
 130 .IP "manual configuration"
 131 To configure in-band control manually, specify the location of the
 132 controller on the \fBovs\-openflowd\fR command line as the \fIcontroller\fR
 133 argument.  You must also configure the network device for the OpenFlow
 134 ``local port'' to allow \fBovs\-openflowd\fR to connect to that controller.
 135 The OpenFlow local port is a virtual network port that \fBovs\-openflowd\fR
 136 bridges to the physical switch ports.  The name of the local port for
 137 a given \fIdatapath\fR may be seen by running \fBovs\-dpctl show
 138 \fIdatapath\fR; the local port is listed as port 0 in \fBshow\fR's
 139 output.
 140
 141 .IP
 142 Before \fBovs\-openflowd\fR starts, the local port network device is not
 143 bridged to any physical network, so the next step depends on whether
 144 connectivity is required to configure the device's IP address.  If the
 145 switch has a static IP address, you may configure its IP address now
 146 with a command such as
 147 .B ifconfig of0 192.168.1.1
 148 and then invoke \fBovs\-openflowd\fR.
 149
 150 On the other hand, if the switch does not have a static IP address,
 151 e.g. it obtains its IP address dynamically via DHCP, the DHCP client
 152 will not be able to contact the DHCP server until the OpenFlow switch
 153 has started up.  Thus, start \fBovs\-openflowd\fR without configuring
 154 the local port network device, and start the DHCP client afterward.
 155 .RE
 156
 157 .SH OPTIONS
 158 .SS "Controller Discovery Options"
 159 .TP
 160 \fB--accept-vconn=\fIregex\fR
 161 When \fBovs\-openflowd\fR performs controller discovery (see \fBContacting
 162 the Controller\fR, above, for more information about controller
 163 discovery), it validates the controller location obtained via DHCP
 164 with a POSIX extended regular expression.  Only controllers whose
 165 names match the regular expression will be accepted.
 166
 167 The default regular expression is \fBssl:.*\fR (meaning that only SSL
 168 controller connections will be accepted) when any of the SSL
 169 configuration options \fB--private-key\fR, \fB--certificate\fR, or
 170 \fB--ca-cert\fR is specified.  The default is \fB^tcp:.*\fR otherwise
 171 (meaning that only TCP controller connections will be accepted).
 172
 173 The \fIregex\fR is implicitly anchored at the beginning of the
 174 controller location string, as if it begins with \fB^\fR.
 175
 176 When controller discovery is not performed, this option has no effect.
 177
 178 .TP
 179 \fB--no-resolv-conf\fR
 180 When \fBovs\-openflowd\fR performs controller discovery (see \fBContacting
 181 the Controller\fR, above, for more information about controller
 182 discovery), by default it overwrites the system's
 183 \fB/etc/resolv.conf\fR with domain information and DNS servers
 184 obtained via DHCP.  If the location of the controller is specified
 185 using a hostname, rather than an IP address, and the network's DNS
 186 servers ever change, this behavior is essential.  But because it also
 187 interferes with any administrator or process that manages
 188 \fB/etc/resolv.conf\fR, when this option is specified, \fBovs\-openflowd\fR
 189 will not modify \fB/etc/resolv.conf\fR.
 190
 191 \fBovs\-openflowd\fR will only modify \fBresolv.conf\fR if the DHCP response
 192 that it receives specifies one or more DNS servers.
 193
 194 When controller discovery is not performed, this option has no effect.
 195
 196 .SS "Networking Options"
 197 .TP
 198 \fB--datapath-id=\fIdpid\fR
 199 Sets \fIdpid\fR, which must consist of exactly 12 hexadecimal digits,
 200 as the datapath ID that the switch will use to identify itself to the
 201 OpenFlow controller.
 202
 203 If this option is omitted, the default datapath ID is taken from the
 204 Ethernet address of the datapath's local port (which is typically
 205 randomly generated).
 206
 207 .TP
 208 \fB--fail=\fR[\fBopen\fR|\fBclosed\fR]
 209 The controller is, ordinarily, responsible for setting up all flows on
 210 the OpenFlow switch.  Thus, if the connection to the controller fails,
 211 no new network connections can be set up.  If the connection to the
 212 controller stays down long enough, no packets can pass through the
 213 switch at all.
 214
 215 If this option is set to \fBopen\fR (the default), \fBovs\-openflowd\fR will
 216 take over responsibility for setting up flows in the local datapath
 217 when no message has been received from the controller for three times
 218 the inactivity probe interval (see below), or 45 seconds by default.
 219 In this ``fail open'' mode, \fBovs\-openflowd\fR causes the datapath to act
 220 like an ordinary MAC-learning switch.  \fBovs\-openflowd\fR will continue to
 221 retry connection to the controller in the background and, when the
 222 connection succeeds, it discontinues its fail-open behavior.
 223
 224 If this option is set to \fBclosed\fR, then \fBovs\-openflowd\fR will not
 225 set up flows on its own when the controller connection fails.
 226
 227 .TP
 228 \fB--inactivity-probe=\fIsecs\fR
 229 When the OpenFlow switch is connected to the controller, the
 230 switch waits for a message to be received from the controller for
 231 \fIsecs\fR seconds before it sends a inactivity probe to the
 232 controller.  After sending the inactivity probe, if no response is
 233 received for an additional \fIsecs\fR seconds, the switch
 234 assumes that the connection has been broken and attempts to reconnect.
 235 The default and the minimum value are both 5 seconds.
 236
 237 When fail-open mode is configured, changing the inactivity probe
 238 interval also changes the interval before entering fail-open mode (see
 239 above).
 240
 241 .TP
 242 \fB--max-idle=\fIsecs\fR|\fBpermanent\fR
 243 Sets \fIsecs\fR as the number of seconds that a flow set up by the
 244 OpenFlow switch will remain in the switch's flow table without any
 245 matching packets being seen.  If \fBpermanent\fR is specified, which
 246 is not recommended, flows set up by the switch will never
 247 expire.  The default is 15 seconds.
 248
 249 Most flows are set up by the OpenFlow controller, not by the
 250 switch.  This option affects only the following flows, which the
 251 OpenFlow switch sets up itself:
 252
 253 .RS
 254 .IP \(bu
 255 When \fB--fail=open\fR is specified, flows set up when the
 256 switch has not been able to contact the controller for the configured
 257 fail-open delay.
 258
 259 .IP \(bu
 260 When in-band control is in use, flows set up to bootstrap contacting
 261 the controller (see \fBContacting the Controller\fR, above, for
 262 more information about in-band control).
 263 .RE
 264
 265 .IP
 266 As a result, when both \fB--fail=closed\fR and \fB--out-of-band\fR are
 267 specified, this option has no effect.
 268
 269 .TP
 270 \fB--max-backoff=\fIsecs\fR
 271 Sets the maximum time between attempts to connect to the controller to
 272 \fIsecs\fR, which must be at least 1.  The actual interval between
 273 connection attempts starts at 1 second and doubles on each failing
 274 attempt until it reaches the maximum.  The default maximum backoff
 275 time is 8 seconds.
 276
 277 .TP
 278 \fB-l\fR, \fB--listen=\fImethod\fR
 279 By default, the switch listens for OpenFlow management connections on a
 280 Unix domain socket named \fB@RUNDIR@/\fIdatapath\fB.mgmt\fR.  This socket
 281 can be used to perform local OpenFlow monitoring and administration with
 282 tools such as \fBovs\-ofctl\fR.
 283
 284 This option may be used to override the default listener.  The \fImethod\fR
 285 must be given as one of the passive OpenFlow connection methods listed
 286 below.  This option may be specified multiple times to listen to
 287 multiple connection methods.  If a single \fImethod\fR of \fBnone\fR is
 288 used, no listeners will be created.
 289
 290 .RS
 291 .so lib/vconn-passive.man
 292 .RE
 293
 294 .TP
 295 \fB--snoop=\fImethod\fR
 296 Configures the switch to additionally listen for incoming OpenFlow
 297 connections for controller connection snooping.  The \fImethod\fR must
 298 be given as one of the passive OpenFlow connection methods listed
 299 under the \fB--listen\fR option above.  This option may be specified
 300 multiple times to listen to multiple connection methods.
 301
 302 If \fBovs\-ofctl monitor\fR is used to connect to \fImethod\fR specified on
 303 \fB--snoop\fR, it will display all the OpenFlow messages traveling
 304 between the switch and its controller on the primary OpenFlow
 305 connection.  This can be useful for debugging switch and controller
 306 problems.
 307
 308 .TP
 309 \fB--in-band\fR, \fB--out-of-band\fR
 310 Configures \fBovs\-openflowd\fR to operate in in-band or out-of-band control
 311 mode (see \fBContacting the Controller\fR above).  When neither option
 312 is given, the default is in-band control.
 313
 314 .TP
 315 \fB--netflow=\fIip\fB:\fIport\fR
 316 Configures the given UDP \fIport\fR on the specified IP \fIip\fR as
 317 a recipient of NetFlow messages for expired flows.  The \fIip\fR must
 318 be specified numerically, not as a DNS name.
 319
 320 This option may be specified multiple times to configure additional
 321 NetFlow collectors.
 322
 323 .SS "Rate-Limiting Options"
 324
 325 These options configure how the switch applies a ``token bucket'' to
 326 limit the rate at which packets in unknown flows are forwarded to an
 327 OpenFlow controller for flow-setup processing.  This feature prevents
 328 a single OpenFlow switch from overwhelming a controller.
 329
 330 .TP
 331 \fB--rate-limit\fR[\fB=\fIrate\fR]
 332 .
 333 Limits the maximum rate at which packets will be forwarded to the
 334 OpenFlow controller to \fIrate\fR packets per second.  If \fIrate\fR
 335 is not specified then the default of 1,000 packets per second is used.
 336
 337 If \fB--rate-limit\fR is not used, then the switch does not limit the
 338 rate at which packets are forwarded to the controller.
 339
 340 .TP
 341 \fB--burst-limit=\fIburst\fR
 342 .
 343 Sets the maximum number of unused packet credits that the switch will
 344 allow to accumulate during time in which no packets are being
 345 forwarded to the OpenFlow controller to \fIburst\fR (measured in
 346 packets).  The default \fIburst\fR is one-quarter of the \fIrate\fR
 347 specified on \fB--rate-limit\fR.
 348
 349 This option takes effect only when \fB--rate-limit\fR is also specified.
 350
 351 .SS "Datapath Options"
 352 .
 353 .IP "\fB\-\-ports=\fIport\fR[\fB,\fIport\fR...]"
 354 Ordinarily, \fBovs\-openflowd\fR expects the administrator to create
 355 the specified \fIdatapath\fR and add ports to it externally with a
 356 utility such as \fBovs\-dpctl\fR.  However, the userspace switch
 357 datapath is implemented inside \fBovs\-openflowd\fR itself and does
 358 not (currently) have any external interface for \fBovs\-dpctl\fR to
 359 access.  As a stopgap measure, this option specifies one or more ports
 360 to add to the datapath at \fBovs\-openflowd\fR startup time.  Multiple
 361 ports may be specified as a comma-separated list or by specifying
 362 \fB\-\-ports\fR multiple times.
 363 .IP
 364 See \fBINSTALL.userspace\fR for more information about userspace
 365 switching.
 366
 367 .SS "Daemon Options"
 368 .so lib/daemon.man
 369
 370 .so lib/ssl.man
 371 .so lib/ssl-bootstrap.man
 372
 373 .SS "Logging Options"
 374 .so lib/vlog.man
 375 .SS "Other Options"
 376 .so lib/common.man
 377 .so lib/leak-checker.man
 378
 379 .SH "SEE ALSO"
 380
 381 .BR ovs\-appctl (8),
 382 .BR ovs\-controller (8),
 383 .BR ovs\-discover (8),
 384 .BR ovs\-dpctl (8),
 385 .BR ovs\-ofctl (8),
 386 .BR ovs\-pki (8),
 387 .BR ovs\-vswitchd.conf (5)