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