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 .SS "Daemon Options"
  87 .ds DD \
  88 \fBovs\-vswitchd\fR detaches only after it has connected to the \
  89 database, retrieved the initial configuration, and set up that \
  90 configuration.
  91 .so lib/daemon.man
  92 .SS "Service Options"
  93 .so lib/service.man
  94 .SS "Public Key Infrastructure Options"
  95 .so lib/ssl.man
  96 .so lib/ssl-bootstrap.man
  97 .so lib/vlog.man
  98 .so lib/common.man
  99 .
 100 .SH "RUNTIME MANAGEMENT COMMANDS"
 101 \fBovs\-appctl\fR(8) can send commands to a running
 102 \fBovs\-vswitchd\fR process.  The currently supported commands are
 103 described below.  The command descriptions assume an understanding of
 104 how to configure Open vSwitch.
 105 .SS "GENERAL COMMANDS"
 106 .IP "\fBexit\fR"
 107 Causes \fBovs\-vswitchd\fR to gracefully terminate.
 108 .IP "\fBqos/show\fR \fIinterface\fR"
 109 Queries the kernel for Quality of Service configuration and statistics
 110 associated with the given \fIinterface\fR.
 111 .IP "\fBbfd/show\fR [\fIinterface\fR]"
 112 Displays detailed information about Bidirectional Forwarding Detection
 113 configured on \fIinterface\fR.  If \fIinterface\fR is not specified,
 114 then displays detailed information about all interfaces with BFD
 115 enabled.
 116 .IP "\fBbfd/set-forwarding\fR [\fIinterface\fR] \fIstatus\fR"
 117 Force the fault status of the BFD module on \fIinterface\fR (or all
 118 interfaces if none is given) to be \fIstatus\fR.  \fIstatus\fR can be
 119 "true", "false", or "normal" which reverts to the standard behavior.
 120 .IP "\fBcfm/show\fR [\fIinterface\fR]"
 121 Displays detailed information about Connectivity Fault Management
 122 configured on \fIinterface\fR.  If \fIinterface\fR is not specified,
 123 then displays detailed information about all interfaces with CFM
 124 enabled.
 125 .IP "\fBcfm/set-fault\fR [\fIinterface\fR] \fIstatus\fR"
 126 Force the fault status of the CFM module on \fIinterface\fR (or all
 127 interfaces if none is given) to be \fIstatus\fR.  \fIstatus\fR can be
 128 "true", "false", or "normal" which reverts to the standard behavior.
 129 .IP "\fBstp/tcn\fR [\fIbridge\fR]"
 130 Forces a topology change event on \fIbridge\fR if it's running STP.  This
 131 may cause it to send Topology Change Notifications to its peers and flush
 132 its MAC table..  If no \fIbridge\fR is given, forces a topology change
 133 event on all bridges.
 134 .SS "BRIDGE COMMANDS"
 135 These commands manage bridges.
 136 .IP "\fBfdb/flush\fR [\fIbridge\fR]"
 137 Flushes \fIbridge\fR MAC address learning table, or all learning tables
 138 if no \fIbridge\fR is given.
 139 .IP "\fBfdb/show\fR \fIbridge\fR"
 140 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 141 along with the port on which it was learned and the age of the entry,
 142 in seconds.
 143 .IP "\fBmdb/flush\fR [\fIbridge\fR]"
 144 Flushes \fIbridge\fR multicast snooping table, or all snooping tables
 145 if no \fIbridge\fR is given.
 146 .IP "\fBmdb/show\fR \fIbridge\fR"
 147 Lists each multicast group/VLAN pair learned by the specified \fIbridge\fR,
 148 along with the port on which it was learned and the age of the entry,
 149 in seconds.
 150 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 151 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 152 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 153 their controller connections and reconnect.
 154 .IP
 155 This command might be useful for debugging OpenFlow controller issues.
 156 .
 157 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 158 Lists all flows in \fIbridge\fR, including those normally hidden to
 159 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 160 such as in-band control and fail-open are hidden from the controller
 161 since it is not allowed to modify or override them.
 162 .SS "BOND COMMANDS"
 163 These commands manage bonded ports on an Open vSwitch's bridges.  To
 164 understand some of these commands, it is important to understand a
 165 detail of the bonding implementation called ``source load balancing''
 166 (SLB).  Instead of directly assigning Ethernet source addresses to
 167 slaves, the bonding implementation computes a function that maps an
 168 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
 169 value).  All of the Ethernet addresses that map to a single 8-bit
 170 value are then assigned to a single slave.
 171 .IP "\fBbond/list\fR"
 172 Lists all of the bonds, and their slaves, on each bridge.
 173 .
 174 .IP "\fBbond/show\fR [\fIport\fR]"
 175 Lists all of the bond-specific information (updelay, downdelay, time
 176 until the next rebalance) about the given bonded \fIport\fR, or all
 177 bonded ports if no \fIport\fR is given.  Also lists information about
 178 each slave: whether it is enabled or disabled, the time to completion
 179 of an updelay or downdelay if one is in progress, whether it is the
 180 active slave, the hashes assigned to the slave.  Any LACP information
 181 related to this bond may be found using the \fBlacp/show\fR command.
 182 .
 183 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 184 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
 185 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
 186 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
 187 new slave to be assigned.
 188 .IP
 189 The reassignment is not permanent: rebalancing or fail-over will
 190 cause the MAC hash to be shifted to a new slave in the usual
 191 manner.
 192 .IP
 193 A MAC hash cannot be migrated to a disabled slave.
 194 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 195 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 196 currently be enabled.
 197 .IP
 198 The setting is not permanent: a new active slave will be selected
 199 if \fIslave\fR becomes disabled.
 200 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 201 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 202 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 203 updelay (or downdelay).
 204 .IP
 205 This setting is not permanent: it persists only until the carrier
 206 status of \fIslave\fR changes.
 207 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]"
 208 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
 209 and \fIbasis\fR if specified.
 210 .
 211 .IP "\fBlacp/show\fR [\fIport\fR]"
 212 Lists all of the LACP related information about the given \fIport\fR:
 213 active or passive, aggregation key, system id, and system priority.  Also
 214 lists information about each slave: whether it is enabled or disabled,
 215 whether it is attached or detached, port id and priority, actor
 216 information, and partner information.  If \fIport\fR is not specified,
 217 then displays detailed information about all interfaces with CFM
 218 enabled.
 219 .SS "DPCTL DATAPATH DEBUGGING COMMANDS"
 220 The primary way to configure \fBovs\-vswitchd\fR is through the Open
 221 vSwitch database, e.g. using \fBovs\-vsctl\fR(8).  These commands
 222 provide a debugging interface for managing datapaths.  They implement
 223 the same features (and syntax) as \fBovs\-dpctl\fR(8).  Unlike
 224 \fBovs\-dpctl\fR(8), these commands work with datapaths that are
 225 integrated into \fBovs\-vswitchd\fR (e.g. the \fBnetdev\fR datapath
 226 type).
 227 .PP
 228 .
 229 .ds DX \fBdpctl/\fR
 230 .de DO
 231 \\$2 \\$1 \\$3
 232 ..
 233 .so lib/dpctl.man
 234 .
 235 .so ofproto/ofproto-dpif-unixctl.man
 236 .so ofproto/ofproto-unixctl.man
 237 .so lib/vlog-unixctl.man
 238 .so lib/memory-unixctl.man
 239 .so lib/coverage-unixctl.man
 240 .
 241 .SH "OPENFLOW IMPLEMENTATION"
 242 .
 243 .PP
 244 This section documents aspects of OpenFlow for which the OpenFlow
 245 specification requires documentation.
 246 .
 247 .SS "Packet buffering."
 248 The OpenFlow specification, version 1.2, says:
 249 .
 250 .IP
 251 Switches that implement buffering are expected to expose, through
 252 documentation, both the amount of available buffering, and the length
 253 of time before buffers may be reused.
 254 .
 255 .PP
 256 Open vSwitch maintains a separate set of 256 packet buffers for each
 257 OpenFlow connection.  Any given packet buffer is preserved until it is
 258 referenced by an \fBOFPT_FLOW_MOD\fR or \fBOFPT_PACKET_OUT\fR request
 259 or for 5 seconds, whichever comes first.
 260 .
 261 .SH "LIMITS"
 262 .
 263 .PP
 264 We believe these limits to be accurate as of this writing.  These
 265 limits assume the use of the Linux kernel datapath.
 266 .
 267 .IP \(bu
 268 \fBovs\-vswitchd\fR started through \fBovs\-ctl\fR(8) provides a limit of 7500
 269 file descriptors.  The limits on the number of bridges and ports is decided by
 270 the availability of file descriptors.  With the Linux kernel datapath, creation
 271 of a single bridge consumes 3 file descriptors and adding a port consumes
 272 1 file descriptor.  Performance will degrade beyond 1,024 ports per bridge due
 273 to fixed hash table sizing.  Other platforms may have different limitations.
 274 .
 275 .IP \(bu
 276 2,048 MAC learning entries per bridge, by default.  (This is
 277 configurable via \fBother\-config:mac\-table\-size\fR in the
 278 \fBBridge\fR table.  See \fBovs\-vswitchd.conf.db\fR(5) for details.)
 279 .
 280 .IP \(bu
 281 Kernel flows are limited only by memory available to the kernel.
 282 Performance will degrade beyond 1,048,576 kernel flows per bridge with
 283 a 32-bit kernel, beyond 262,144 with a 64-bit kernel.
 284 (\fBovs\-vswitchd\fR should never install anywhere near that many
 285 flows.)
 286 .
 287 .IP \(bu
 288 OpenFlow flows are limited only by available memory.  Performance is
 289 linear in the number of unique wildcard patterns.  That is, an
 290 OpenFlow table that contains many flows that all match on the same
 291 fields in the same way has a constant-time lookup, but a table that
 292 contains many flows that match on different fields requires lookup
 293 time linear in the number of flows.
 294 .
 295 .IP \(bu
 296 255 ports per bridge participating in 802.1D Spanning Tree Protocol.
 297 .
 298 .IP \(bu
 299 32 mirrors per bridge.
 300 .
 301 .IP \(bu
 302 15 bytes for the name of a port.  (This is a Linux kernel limitation.)
 303 .
 304 .SH "SEE ALSO"
 305 .BR ovs\-appctl (8),
 306 .BR ovsdb\-server (1),
 307 \fBINSTALL.Linux\fR in the Open vSwitch distribution.