utilities/ovs-controller.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-controller 8 "@VERSION@" "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 has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
  48 (because the controller does not set up flows in that case).
  49 .
  50 .IP "\fB\-H\fR"
  51 .IQ "\fB\-\-hub\fR"
  52 By default, the controller acts as an L2 MAC-learning switch.  This
  53 option changes its behavior to that of a hub that floods packets on
  54 all but the incoming port.
  55 .IP
  56 If \fB\-H\fR (or \fB\-\-hub\fR) and \fB\-n\fR (or \fB\-\-noflow\fR) are used
  57 together, then the cumulative effect is that every packet passes
  58 through the controller and every packet is flooded.
  59 .IP
  60 This option is most useful for debugging.  It reduces switching
  61 performance, so it should not be used in production.
  62 .
  63 .IP "\fB\-w\fR[\fIwildcard_mask\fR]"
  64 .IQ "\fB\-\-wildcards\fR[\fB=\fIwildcard_mask\fR]\fR"
  65 By default, \fBovs\-controller\fR sets up exact-match flows.  This
  66 option allows it to set up wildcarded flows, which may reduce
  67 flow setup latency by causing less traffic to be sent up to the
  68 controller.
  69 .IP
  70 The optional \fIwildcard_mask\fR is an OpenFlow wildcard bitmask in
  71 hexadecimal that specifies the fields to wildcard.  If no
  72 \fIwildcard_mask\fR is specified, the default value 0x2820F0 is used
  73 which specifies L2-only switching and wildcards L3 and L4 fields.
  74 Another interesting value is 0x2000EC, which specifies L3-only
  75 switching and wildcards L2 and L4 fields.
  76 .IP
  77 This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
  78 (because the controller does not set up flows in that case).
  79 .
  80 .IP "\fB\-N\fR"
  81 .IQ "\fB\-\-normal\fR"
  82 By default, \fBovs\-controller\fR directs packets to a particular port
  83 or floods them.  This option causes it to direct non-flooded packets
  84 to the OpenFlow \fBOFPP_NORMAL\fR port.  This allows the switch itself
  85 to make decisions about packet destinations.  Support for
  86 \fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well
  87 with some non-Open vSwitch switches.
  88 .
  89 .IP "\fB\-\-mute\fR"
  90 Prevents ovs\-controller from replying to any OpenFlow messages sent
  91 to it by switches.
  92 .IP
  93 This option is only for debugging the Open vSwitch implementation of
  94 ``fail open'' mode.  It must not be used in production.
  95 .
  96 .IP "\fB\-q \fIid\fR"
  97 .IQ "\fB\-\-queue=\fIid\fR"
  98 By default, \fBovs\-controller\fR uses the default OpenFlow queue for
  99 sending packets and setting up flows.  Use one of these options,
 100 supplying \fIid\fR as an OpenFlow queue ID as a decimal number, to
 101 instead use that specific queue.
 102 .IP
 103 This option is incompatible with \fB\-N\fR or \fB\-\-normal\fR and
 104 with \fB\-H\fR or \fB\-\-hub\fR.  If more than one is specified then
 105 this option takes precedence.
 106 .IP
 107 This option may be useful for testing or debugging quality of service
 108 setups.
 109 .
 110 .IP "\fB\-Q \fIport-name\fB:\fIqueue-id\fR"
 111 .IP "\fB\-\-port\-queue \fIport-name\fB:\fIqueue-id\fR"
 112 Configures packets received on the port named \fIport-name\fR
 113 (e.g. \fBeth0\fR) to be output on OpenFlow queue ID \fIqueue-id\fR
 114 (specified as a decimal number).  For the specified port, this option
 115 overrides the default specified on \fB\-q\fR or \fB\-\-queue\fR.
 116 .IP
 117 This option may be specified any number of times with different
 118 \fIport-name\fR arguments.
 119 .IP
 120 This option is incompatible with \fB\-N\fR or \fB\-\-normal\fR and
 121 with \fB\-H\fR or \fB\-\-hub\fR.  If more than one is specified then
 122 this option takes precedence.
 123 .IP
 124 This option may be useful for testing or debugging quality of service
 125 setups.
 126 .
 127 .IP "\fB\-\-with\-flows \fIfile\fR"
 128 When a switch connects, push the flow entries as described in
 129 \fIfile\fR.  Each line in \fIfile\fR is a flow entry in the format
 130 described for the \fBadd\-flows\fR command in the \fBFlow Syntax\fR
 131 section of the \fBovs\-ofctl\fR(8) man page.
 132 .IP
 133 Use this option more than once to add flows from multiple files.
 134 .
 135 .SS "Public Key Infrastructure Options"
 136 .so lib/ssl.man
 137 .so lib/ssl-peer-ca-cert.man
 138 .ds DD
 139 .so lib/daemon.man
 140 .so lib/vlog.man
 141 .so lib/unixctl.man
 142 .so lib/common.man
 143 .so so lib/ofp-version.man
 144 .
 145 .SH EXAMPLES
 146 .PP
 147 To bind locally to port 6633 (the default) and wait for incoming
 148 connections from OpenFlow switches:
 149 .IP
 150 \fB% ovs\-controller ptcp:\fR
 151 .PP
 152 In the future, the default port number will change to 6653, which is the
 153 IANA-defined value.
 154 .SH "BUGS"
 155 .PP
 156 Configuring a Citrix XenServer to connect to a particular controller
 157 only points the remote OVSDB management connection to that controller.
 158 It does not also configure OpenFlow connections, because the manager
 159 is expected to do that over the management protocol.
 160 \fBovs\-controller\fR is not an Open vSwitch manager and does not know
 161 how to do that.
 162 .PP
 163 As a stopgap workaround, \fBovs\-vsctl\fR can wait for an OVSDB
 164 connection and set the controller, e.g.:
 165 .IP
 166 \fB% ovs\-vsctl \-t0 \-\-db=pssl: \-\-certificate=cert.pem
 167 \-\-ca\-cert=none \-\-private\-key=privkey.pem
 168 \-\-peer\-ca\-cert=cacert.pem set\-controller ssl:\fIip\fR
 169 .SH "SEE ALSO"
 170 .
 171 .BR ovs\-appctl (8),
 172 .BR ovs\-ofctl (8),
 173 .BR ovs\-dpctl (8)