utilities/ovs-controller.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-controller 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
   8 .ds PN ovs\-controller
   9 .
  10 .SH NAME
  11 ovs\-controller \- simple OpenFlow controller reference implementation
  12 .
  13 .SH SYNOPSIS
  14 .B ovs\-controller
  15 [\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&...
  16 .
  17 .SH DESCRIPTION
  18 \fBovs\-controller\fR manages any number of remote switches over OpenFlow
  19 protocol, causing them to function as L2 MAC-learning switches or hub.
  20 .PP
  21 \fBovs\-controller\fR controls one or more OpenFlow switches, specified as
  22 one or more of the following OpenFlow connection methods:
  23 .
  24 .RS
  25 .so lib/vconn-passive.man
  26 .so lib/vconn-active.man
  27 .RE
  28 .
  29 .SH OPTIONS
  30 .IP "\fB\-n\fR"
  31 .IQ "\fB\-\-noflow\fR"
  32 By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch
  33 whenever it receives a packet whose destination is known due through
  34 MAC learning.  This option disables flow setup, so that every packet
  35 in the network passes through the controller.
  36 .IP
  37 This option is most useful for debugging.  It reduces switching
  38 performance, so it should not be used in production.
  39 .
  40 .TP
  41 \fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR
  42 Sets \fIsecs\fR as the number of seconds that a flow set up by the
  43 controller will remain in the switch's flow table without any matching
  44 packets being seen.  If \fBpermanent\fR is specified, which is not
  45 recommended, flows will never expire.  The default is 60 seconds.
  46 .IP
  47 This option affects only flows set up by the OpenFlow controller.  In
  48 some configurations, the switch can set up some flows
  49 on its own.  To set the idle time for those flows, pass
  50 \fB\-\-max\-idle\fR to \fBovs\-openflowd\fR (on the switch).
  51 .IP
  52 This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
  53 (because the controller does not set up flows in that case).
  54 .
  55 .IP "\fB\-H\fR"
  56 .IQ "\fB\-\-hub\fR"
  57 By default, the controller acts as an L2 MAC-learning switch.  This
  58 option changes its behavior to that of a hub that floods packets on
  59 all but the incoming port.
  60 .IP
  61 If \fB\-H\fR (or \fB\-\-hub\fR) and \fB\-n\fR (or \fB\-\-noflow\fR) are used
  62 together, then the cumulative effect is that every packet passes
  63 through the controller and every packet is flooded.
  64 .IP
  65 This option is most useful for debugging.  It reduces switching
  66 performance, so it should not be used in production.
  67 .
  68 .IP "\fB\-w\fR"
  69 .IQ "\fB\-\-wildcard\fR"
  70 By default, \fBovs\-controller\fR sets up exact-match flows.  This
  71 option allows it to set up wildcarded flows, which may reduce
  72 flow-setup latency by causing less traffic to be sent up to the
  73 controller.
  74 .IP
  75 This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
  76 (because the controller does not set up flows in that case).
  77 .
  78 .IP "\fB\-N\fR"
  79 .IQ "\fB\-\-normal\fR"
  80 By default, \fBovs\-controller\fR directs packets to a particular port
  81 or floods them.  This option causes it to direct non-flooded packets
  82 to the OpenFlow \fBOFPP_NORMAL\fR port.  This allows the switch itself
  83 to make decisions about packet destinations.  Support for
  84 \fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well
  85 with some non-Open vSwitch switches.
  86 .
  87 .IP "\fB\-\-mute\fR"
  88 Prevents ovs\-controller from replying to any OpenFlow messages sent
  89 to it by switches.
  90 .IP
  91 This option is only for debugging the Open vSwitch implementation of
  92 ``fail open'' mode.  It must not be used in production.
  93 .
  94 .IP "\fB\-q \fIid\fR"
  95 .IQ "\fB\-\-queue=\fIid\fR"
  96 By default, \fBovs\-controller\fR uses the default OpenFlow queue for
  97 sending packets and setting up flows.  Use one of these options,
  98 supplying \fIid\fR as an OpenFlow queue ID as a decimal number, to
  99 instead use that specific queue.
 100 .IP
 101 This option is incompatible with \fB\-N\fR or \fB\-\-normal\fR and
 102 with \fB\-H\fR or \fB\-\-hub\fR.  If more than one is specified then
 103 this option takes precedence.
 104 .IP
 105 This option may be useful for testing or debugging quality of service
 106 setups.
 107 .
 108 .IP "\fB\-Q \fIport-name\fB:\fIqueue-id\fR"
 109 .IP "\fB\-\-port\-queue \fIport-name\fB:\fIqueue-id\fR"
 110 Configures packets received on the port named \fIport-name\fR
 111 (e.g. \fBeth0\fR) to be output on OpenFlow queue ID \fIqueue-id\fR
 112 (specified as a decimal number).  For the specified port, this option
 113 overrides the default specified on \fB\-q\fR or \fB\-\-queue\fR.
 114 .IP
 115 This option may be specified any number of times with different
 116 \Iport-name\fR arguments.
 117 .IP
 118 This option is incompatible with \fB\-N\fR or \fB\-\-normal\fR and
 119 with \fB\-H\fR or \fB\-\-hub\fR.  If more than one is specified then
 120 this option takes precedence.
 121 .IP
 122 This option may be useful for testing or debugging quality of service
 123 setups.
 124 .
 125 .IP "\fB\-\-with\-flows \fIfile\fR"
 126 When a switch connects, push the flow entries as described in
 127 \fIfile\fR.  Each line in \fIfile\fR is a flow entry in the format
 128 described for the \fBadd\-flows\fR command in the \fBFlow Syntax\fR
 129 section of the \fBovs\-ofctl\fR(8) man page.
 130 .IP
 131 Use this option more than once to add flows from multiple files.
 132 .
 133 .SS "Public Key Infrastructure Options"
 134 .so lib/ssl.man
 135 .so lib/ssl-peer-ca-cert.man
 136 .so lib/daemon.man
 137 .so lib/vlog.man
 138 .so lib/unixctl.man
 139 .so lib/common.man
 140 .
 141 .SH EXAMPLES
 142 .PP
 143 To bind locally to port 6633 (the default) and wait for incoming
 144 connections from OpenFlow switches:
 145 .IP
 146 \fB% ovs\-controller ptcp:\fR
 147 .SH "BUGS"
 148 .PP
 149 Configuring a Citrix XenServer to connect to a particular controller
 150 only points the remote OVSDB management connection to that controller.
 151 It does not also configure OpenFlow connections, because the manager
 152 is expected to do that over the management protocol.
 153 \fBovs\-controller\fR is not an Open vSwitch manager and does not know
 154 how to do that.
 155 .PP
 156 As a stopgap workaround, \fBovs\-vsctl\fR can wait for an OVSDB
 157 connection and set the controller, e.g.:
 158 .IP
 159 \fB% ovs\-vsctl \-t0 \-\-db=pssl: \-\-certificate=cert.pem
 160 \-\-ca\-cert=none \-\-private\-key=privkey.pem
 161 \-\-peer\-ca\-cert=cacert.pem set\-controller ssl:\fIip\fR
 162 .SH "SEE ALSO"
 163 .
 164 .BR ovs\-openflowd (8),
 165 .BR ovs\-appctl (8),
 166 .BR ovs\-ofctl (8),
 167 .BR ovs\-dpctl (8)