vswitchd/ovs-vswitchd.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
   8 .\" This program's name:
   9 .ds PN ovs\-vswitchd
  10 .\" SSL peer program's name:
  11 .ds SN ovs\-controller
  12 .
  13 .SH NAME
  14 ovs\-vswitchd \- Open vSwitch daemon
  15 .
  16 .SH SYNOPSIS
  17 .B ovs\-vswitchd
  18 \fIdatabase\fR
  19 .
  20 .SH DESCRIPTION
  21 A daemon that manages and controls any number of Open vSwitch switches
  22 on the local machine.
  23 .PP
  24 The mandatory \fIdatabase\fR argument normally takes the form
  25 \fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain
  26 socket on which \fBovsdb\-server\fR is listening.  However, all of the
  27 following forms are accepted:
  28 .so ovsdb/remote-active.man
  29 .so ovsdb/remote-passive.man
  30 .PP
  31 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
  32 startup.  It sets up Open vSwitch datapaths and then operates
  33 switching across each bridge described in its configuration files.  As
  34 the database changes, \fBovs\-vswitchd\fR automatically updates its
  35 configuration to match.
  36 .PP
  37 Upon receipt of a SIGHUP signal, \fBovs\-vswitchd\fR reopens its log
  38 file, if one was specified on the command line.
  39 .PP
  40 \fBovs\-vswitchd\fR switches may be configured with any of the following
  41 features:
  42 .
  43 .IP \(bu
  44 L2 switching with MAC learning.
  45 .
  46 .IP \(bu
  47 NIC bonding with automatic fail-over and source MAC-based TX load
  48 balancing ("SLB").
  49 .
  50 .IP \(bu
  51 802.1Q VLAN support.
  52 .
  53 .IP \(bu
  54 Port mirroring, with optional VLAN tagging.
  55 .
  56 .IP \(bu
  57 NetFlow v5 flow logging.
  58 .
  59 .IP \(bu
  60 sFlow(R) monitoring.
  61 .
  62 .IP \(bu
  63 Connectivity to an external OpenFlow controller, such as NOX.
  64 .
  65 .PP
  66 Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
  67 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
  68 to the maximum number of supported Open vSwitch datapaths.
  69 .PP
  70 \fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR,
  71 and more.  Do not run both daemons at the same time.
  72 .PP
  73 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
  74 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  75 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  76 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  77 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  78 .PP
  79 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  80 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  81 Open vSwitch distribution for instructions on how to build and load
  82 the Open vSwitch kernel module.
  83 .PP
  84 .SH OPTIONS
  85 .IP "\fB\-\-mlockall\fR"
  86 Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
  87 attempt to lock all of its process memory into physical RAM,
  88 preventing the kernel from paging any of its memory to disk.  This
  89 helps to avoid networking interruptions due to system memory pressure.
  90 .IP
  91 Some systems do not support \fBmlockall()\fR at all, and other systems
  92 only allow privileged users, such as the superuser, to use it.
  93 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
  94 unavailable or unsuccessful.
  95 .
  96 .IP "\fB\-\-fake\-proc\-net\fR"
  97 Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
  98 and \fB/proc/net/bonding\fR that some legacy software expects to
  99 exist.  This option should only be used if such legacy software is
 100 actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
 101 to be loaded.
 102 .IP
 103 On non-Linux hosts, this option is accepted but has no effect.
 104 .
 105 .ds DD \
 106 \fBovs\-vswitchd\fR detaches only after it has connected to the \
 107 database, retrieved the initial configuration, and set up that \
 108 configuration.
 109 .so lib/daemon.man
 110 .SS "Public Key Infrastructure Options"
 111 .so lib/ssl.man
 112 .so lib/ssl-bootstrap.man
 113 .so lib/vlog.man
 114 .so lib/common.man
 115 .so lib/leak-checker.man
 116 .
 117 .SH "RUNTIME MANAGEMENT COMMANDS"
 118 \fBovs\-appctl\fR(8) can send commands to a running
 119 \fBovs\-vswitchd\fR process.  The currently supported commands are
 120 described below.  The command descriptions assume an understanding of
 121 how to configure Open vSwitch.
 122 .SS "GENERAL COMMANDS"
 123 .IP "\fBexit\fR"
 124 Causes \fBovs\-vswitchd\fR to gracefully terminate.
 125 .SS "BRIDGE COMMANDS"
 126 These commands manage bridges.
 127 .IP "\fBfdb/show\fR \fIbridge\fR"
 128 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 129 along with the port on which it was learned and the age of the entry,
 130 in seconds.
 131 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 132 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 133 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 134 their controller connections and reconnect.
 135 .IP
 136 This command might be useful for debugging OpenFlow controller issues.
 137 .
 138 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 139 Lists all flows in \fIbridge\fR, including those normally hidden to
 140 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 141 such as in-band control and fail-open are hidden from the controller
 142 since it is not allowed to modify or override them.
 143 .SS "BOND COMMANDS"
 144 These commands manage bonded ports on an Open vSwitch's bridges.  To
 145 understand some of these commands, it is important to understand a
 146 detail of the bonding implementation called ``source load balancing''
 147 (SLB).  Instead of directly assigning Ethernet source addresses to
 148 slaves, the bonding implementation computes a function that maps an
 149 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
 150 value).  All of the Ethernet addresses that map to a single 8-bit
 151 value are then assigned to a single slave.
 152 .IP "\fBbond/list\fR"
 153 Lists all of the bonds, and their slaves, on each bridge.
 154 .
 155 .IP "\fBbond/show\fR \fIport\fR"
 156 Lists all of the bond-specific information about the given bonded
 157 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
 158 lists information about each slave: whether it is enabled or disabled,
 159 the time to completion of an updelay or downdelay if one is in
 160 progress, whether it is the active slave, the MAC hashes assigned to
 161 the slave, and the MAC learning table entries that hash to each MAC.
 162 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 163 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
 164 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
 165 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
 166 new slave to be assigned.
 167 .IP
 168 The reassignment is not permanent: rebalancing or fail-over will
 169 cause the MAC hash to be shifted to a new slave in the usual
 170 manner.
 171 .IP
 172 A MAC hash cannot be migrated to a disabled slave.
 173 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 174 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 175 currently be enabled.
 176 .IP
 177 The setting is not permanent: a new active slave will be selected
 178 if \fIslave\fR becomes disabled.
 179 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 180 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 181 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 182 updelay (or downdelay).
 183 .IP
 184 This setting is not permanent: it persists only until the carrier
 185 status of \fIslave\fR changes.
 186 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR]"
 187 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
 188 if specified.
 189 .
 190 .so ofproto/ofproto-unixctl.man
 191 .so lib/vlog-unixctl.man
 192 .so lib/stress-unixctl.man
 193 .SH "SEE ALSO"
 194 .BR ovs\-appctl (8),
 195 .BR ovs\-brcompatd (8),
 196 .BR ovsdb\-server (1),
 197 \fBINSTALL.Linux\fR in the Open vSwitch distribution.