vswitchd/ovs-vswitchd.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-vswitchd 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
   8 .\" This program's name:
   9 .ds PN ovs\-vswitchd
  10 .
  11 .SH NAME
  12 ovs\-vswitchd \- Open vSwitch daemon
  13 .
  14 .SH SYNOPSIS
  15 \fBovs\-vswitchd \fR[\fIdatabase\fR]
  16 .
  17 .SH DESCRIPTION
  18 A daemon that manages and controls any number of Open vSwitch switches
  19 on the local machine.
  20 .PP
  21 The \fIdatabase\fR argument specifies how \fBovs\-vswitchd\fR connects
  22 to \fBovsdb\-server\fR.  The default is \fBunix:@RUNDIR@/db.sock\fR.
  23 The following forms are accepted:
  24 .so ovsdb/remote-active.man
  25 .so ovsdb/remote-passive.man
  26 .PP
  27 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
  28 startup.  It sets up Open vSwitch datapaths and then operates
  29 switching across each bridge described in its configuration files.  As
  30 the database changes, \fBovs\-vswitchd\fR automatically updates its
  31 configuration to match.
  32 .PP
  33 \fBovs\-vswitchd\fR switches may be configured with any of the following
  34 features:
  35 .
  36 .IP \(bu
  37 L2 switching with MAC learning.
  38 .
  39 .IP \(bu
  40 NIC bonding with automatic fail-over and source MAC-based TX load
  41 balancing ("SLB").
  42 .
  43 .IP \(bu
  44 802.1Q VLAN support.
  45 .
  46 .IP \(bu
  47 Port mirroring, with optional VLAN tagging.
  48 .
  49 .IP \(bu
  50 NetFlow v5 flow logging.
  51 .
  52 .IP \(bu
  53 sFlow(R) monitoring.
  54 .
  55 .IP \(bu
  56 Connectivity to an external OpenFlow controller, such as NOX.
  57 .
  58 .PP
  59 Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
  60 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
  61 to the maximum number of supported Open vSwitch datapaths.
  62 .PP
  63 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
  64 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  65 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  66 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  67 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  68 .PP
  69 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  70 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  71 Open vSwitch distribution for instructions on how to build and load
  72 the Open vSwitch kernel module.
  73 .PP
  74 .SH OPTIONS
  75 .IP "\fB\-\-mlockall\fR"
  76 Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
  77 attempt to lock all of its process memory into physical RAM,
  78 preventing the kernel from paging any of its memory to disk.  This
  79 helps to avoid networking interruptions due to system memory pressure.
  80 .IP
  81 Some systems do not support \fBmlockall()\fR at all, and other systems
  82 only allow privileged users, such as the superuser, to use it.
  83 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
  84 unavailable or unsuccessful.
  85 .
  86 .IP "\fB\-\-enable\-of14\fR"
  87 Specifying this option allows OpenFlow 1.4 to be used if it is enabled
  88 through the \fBprotocols\fR column in the \fBController\fR.  Without
  89 this option, \fBovs\-vswitchd\fR will not use OpenFlow 1.4 even if it
  90 is enabled that way.  This option is present because OpenFlow 1.4
  91 support is not safe: the daemon will abort when certain unimplemented
  92 features are tested.  Thus, for now it is suitable only for
  93 experimental use.  When the support is implemented safely, this option
  94 will be removed.
  95 .
  96 .SS "Daemon Options"
  97 .ds DD \
  98 \fBovs\-vswitchd\fR detaches only after it has connected to the \
  99 database, retrieved the initial configuration, and set up that \
 100 configuration.
 101 .so lib/daemon.man
 102 .SS "Service Options"
 103 .so lib/service.man
 104 .SS "Public Key Infrastructure Options"
 105 .so lib/ssl.man
 106 .so lib/ssl-bootstrap.man
 107 .so lib/vlog.man
 108 .so lib/common.man
 109 .
 110 .SH "RUNTIME MANAGEMENT COMMANDS"
 111 \fBovs\-appctl\fR(8) can send commands to a running
 112 \fBovs\-vswitchd\fR process.  The currently supported commands are
 113 described below.  The command descriptions assume an understanding of
 114 how to configure Open vSwitch.
 115 .SS "GENERAL COMMANDS"
 116 .IP "\fBexit\fR"
 117 Causes \fBovs\-vswitchd\fR to gracefully terminate.
 118 .IP "\fBqos/show\fR \fIinterface\fR"
 119 Queries the kernel for Quality of Service configuration and statistics
 120 associated with the given \fIinterface\fR.
 121 .IP "\fBbfd/show\fR [\fIinterface\fR]"
 122 Displays detailed information about Bidirectional Forwarding Detection
 123 configured on \fIinterface\fR.  If \fIinterface\fR is not specified,
 124 then displays detailed information about all interfaces with BFD
 125 enabled.
 126 .IP "\fBbfd/set-forwarding\fR [\fIinterface\fR] \fIstatus\fR"
 127 Force the fault status of the BFD module on \fIinterface\fR (or all
 128 interfaces if none is given) to be \fIstatus\fR.  \fIstatus\fR can be
 129 "true", "false", or "normal" which reverts to the standard behavior.
 130 .IP "\fBcfm/show\fR [\fIinterface\fR]"
 131 Displays detailed information about Connectivity Fault Management
 132 configured on \fIinterface\fR.  If \fIinterface\fR is not specified,
 133 then displays detailed information about all interfaces with CFM
 134 enabled.
 135 .IP "\fBcfm/set-fault\fR [\fIinterface\fR] \fIstatus\fR"
 136 Force the fault status of the CFM module on \fIinterface\fR (or all
 137 interfaces if none is given) to be \fIstatus\fR.  \fIstatus\fR can be
 138 "true", "false", or "normal" which reverts to the standard behavior.
 139 .IP "\fBstp/tcn\fR [\fIbridge\fR]"
 140 Forces a topology change event on \fIbridge\fR if it's running STP.  This
 141 may cause it to send Topology Change Notifications to its peers and flush
 142 its MAC table..  If no \fIbridge\fR is given, forces a topology change
 143 event on all bridges.
 144 .SS "BRIDGE COMMANDS"
 145 These commands manage bridges.
 146 .IP "\fBfdb/flush\fR [\fIbridge\fR]"
 147 Flushes \fIbridge\fR MAC address learning table, or all learning tables
 148 if no \fIbridge\fR is given.
 149 .IP "\fBfdb/show\fR \fIbridge\fR"
 150 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 151 along with the port on which it was learned and the age of the entry,
 152 in seconds.
 153 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 154 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 155 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 156 their controller connections and reconnect.
 157 .IP
 158 This command might be useful for debugging OpenFlow controller issues.
 159 .
 160 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 161 Lists all flows in \fIbridge\fR, including those normally hidden to
 162 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 163 such as in-band control and fail-open are hidden from the controller
 164 since it is not allowed to modify or override them.
 165 .SS "BOND COMMANDS"
 166 These commands manage bonded ports on an Open vSwitch's bridges.  To
 167 understand some of these commands, it is important to understand a
 168 detail of the bonding implementation called ``source load balancing''
 169 (SLB).  Instead of directly assigning Ethernet source addresses to
 170 slaves, the bonding implementation computes a function that maps an
 171 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
 172 value).  All of the Ethernet addresses that map to a single 8-bit
 173 value are then assigned to a single slave.
 174 .IP "\fBbond/list\fR"
 175 Lists all of the bonds, and their slaves, on each bridge.
 176 .
 177 .IP "\fBbond/show\fR [\fIport\fR]"
 178 Lists all of the bond-specific information (updelay, downdelay, time
 179 until the next rebalance) about the given bonded \fIport\fR, or all
 180 bonded ports if no \fIport\fR is given.  Also lists information about
 181 each slave: whether it is enabled or disabled, the time to completion
 182 of an updelay or downdelay if one is in progress, whether it is the
 183 active slave, the hashes assigned to the slave.  Any LACP information
 184 related to this bond may be found using the \fBlacp/show\fR command.
 185 .
 186 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 187 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
 188 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
 189 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
 190 new slave to be assigned.
 191 .IP
 192 The reassignment is not permanent: rebalancing or fail-over will
 193 cause the MAC hash to be shifted to a new slave in the usual
 194 manner.
 195 .IP
 196 A MAC hash cannot be migrated to a disabled slave.
 197 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 198 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 199 currently be enabled.
 200 .IP
 201 The setting is not permanent: a new active slave will be selected
 202 if \fIslave\fR becomes disabled.
 203 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 204 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 205 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 206 updelay (or downdelay).
 207 .IP
 208 This setting is not permanent: it persists only until the carrier
 209 status of \fIslave\fR changes.
 210 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]"
 211 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
 212 and \fIbasis\fR if specified.
 213 .
 214 .IP "\fBlacp/show\fR [\fIport\fR]"
 215 Lists all of the LACP related information about the given \fIport\fR:
 216 active or passive, aggregation key, system id, and system priority.  Also
 217 lists information about each slave: whether it is enabled or disabled,
 218 whether it is attached or detached, port id and priority, actor
 219 information, and partner information.  If \fIport\fR is not specified,
 220 then displays detailed information about all interfaces with CFM
 221 enabled.
 222 .
 223 .so ofproto/ofproto-dpif-unixctl.man
 224 .so ofproto/ofproto-unixctl.man
 225 .so lib/vlog-unixctl.man
 226 .so lib/memory-unixctl.man
 227 .so lib/coverage-unixctl.man
 228 .
 229 .SH "OPENFLOW IMPLEMENTATION"
 230 .
 231 .PP
 232 This section documents aspects of OpenFlow for which the OpenFlow
 233 specification requires documentation.
 234 .
 235 .SS "Packet buffering."
 236 The OpenFlow specification, version 1.2, says:
 237 .
 238 .IP
 239 Switches that implement buffering are expected to expose, through
 240 documentation, both the amount of available buffering, and the length
 241 of time before buffers may be reused.
 242 .
 243 .PP
 244 Open vSwitch maintains a separate set of 256 packet buffers for each
 245 OpenFlow connection.  Any given packet buffer is preserved until it is
 246 referenced by an \fBOFPT_FLOW_MOD\fR or \fBOFPT_PACKET_OUT\fR request
 247 or for 5 seconds, whichever comes first.
 248 .
 249 .SH "LIMITS"
 250 .
 251 .PP
 252 We believe these limits to be accurate as of this writing.  These
 253 limits assume the use of the Linux kernel datapath.
 254 .
 255 .IP \(bu
 256 \fBovs\-vswitchd\fR started through \fBovs\-ctl\fR(8) provides a limit of 7500
 257 file descriptors.  The limits on the number of bridges and ports is decided by
 258 the availability of file descriptors.  With the Linux kernel datapath, creation
 259 of a single bridge consumes 3 file descriptors and adding a port consumes
 260 1 file descriptor.  Performance will degrade beyond 1,024 ports per bridge due
 261 to fixed hash table sizing.  Other platforms may have different limitations.
 262 .
 263 .IP \(bu
 264 2,048 MAC learning entries per bridge, by default.  (This is
 265 configurable via \fBother\-config:mac\-table\-size\fR in the
 266 \fBBridge\fR table.  See \fBovs\-vswitchd.conf.db\fR(5) for details.)
 267 .
 268 .IP \(bu
 269 Kernel flows are limited only by memory available to the kernel.
 270 Performance will degrade beyond 1,048,576 kernel flows per bridge with
 271 a 32-bit kernel, beyond 262,144 with a 64-bit kernel.
 272 (\fBovs\-vswitchd\fR should never install anywhere near that many
 273 flows.)
 274 .
 275 .IP \(bu
 276 OpenFlow flows are limited only by available memory.  Performance is
 277 linear in the number of unique wildcard patterns.  That is, an
 278 OpenFlow table that contains many flows that all match on the same
 279 fields in the same way has a constant-time lookup, but a table that
 280 contains many flows that match on different fields requires lookup
 281 time linear in the number of flows.
 282 .
 283 .IP \(bu
 284 255 ports per bridge participating in 802.1D Spanning Tree Protocol.
 285 .
 286 .IP \(bu
 287 32 mirrors per bridge.
 288 .
 289 .IP \(bu
 290 15 bytes for the name of a port.  (This is a Linux kernel limitation.)
 291 .
 292 .SH "SEE ALSO"
 293 .BR ovs\-appctl (8),
 294 .BR ovsdb\-server (1),
 295 \fBINSTALL.Linux\fR in the Open vSwitch distribution.