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 does all the necessary management of Open vSwitch datapaths
  71 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  72 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  73 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  74 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  75 .PP
  76 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  77 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  78 Open vSwitch distribution for instructions on how to build and load
  79 the Open vSwitch kernel module.
  80 .PP
  81 .SH OPTIONS
  82 .IP "\fB\-\-mlockall\fR"
  83 Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
  84 attempt to lock all of its process memory into physical RAM,
  85 preventing the kernel from paging any of its memory to disk.  This
  86 helps to avoid networking interruptions due to system memory pressure.
  87 .IP
  88 Some systems do not support \fBmlockall()\fR at all, and other systems
  89 only allow privileged users, such as the superuser, to use it.
  90 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
  91 unavailable or unsuccessful.
  92 .
  93 .IP "\fB\-\-fake\-proc\-net\fR"
  94 Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
  95 and \fB/proc/net/bonding\fR that some legacy software expects to
  96 exist.  This option should only be used if such legacy software is
  97 actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
  98 to be loaded.
  99 .IP
 100 On non-Linux hosts, this option is accepted but has no effect.
 101 .
 102 .so lib/daemon.man
 103 .SS "Public Key Infrastructure Options"
 104 .so lib/ssl.man
 105 .so lib/ssl-bootstrap.man
 106 .so lib/vlog.man
 107 .so lib/common.man
 108 .so lib/leak-checker.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 .SS "BRIDGE COMMANDS"
 119 These commands manage bridges.
 120 .IP "\fBfdb/show\fR \fIbridge\fR"
 121 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 122 along with the port on which it was learned and the age of the entry,
 123 in seconds.
 124 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 125 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 126 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 127 their controller connections and reconnect.
 128 .IP
 129 This command might be useful for debugging OpenFlow controller issues.
 130 .
 131 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 132 Lists all flows in \fIbridge\fR, including those normally hidden to
 133 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 134 such as in-band control and fail-open are hidden from the controller
 135 since it is not allowed to modify or override them.
 136 .SS "BOND COMMANDS"
 137 These commands manage bonded ports on an Open vSwitch's bridges.  To
 138 understand some of these commands, it is important to understand a
 139 detail of the bonding implementation called ``MAC hashing.''  Instead
 140 of directly assigning Ethernet source addresses to slaves, the bonding
 141 implementation computes a function that maps an 48-bit Ethernet source
 142 addresses into an 8-bit value (a ``MAC hash'' value).  All of the
 143 Ethernet addresses that map to a single 8-bit value are then assigned
 144 to a single slave.
 145 .IP "\fBbond/list\fR"
 146 Lists all of the bonds, and their slaves, on each bridge.
 147 .
 148 .IP "\fBbond/show\fR \fIport\fR"
 149 Lists all of the bond-specific information about the given bonded
 150 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
 151 lists information about each slave: whether it is enabled or disabled,
 152 the time to completion of an updelay or downdelay if one is in
 153 progress, whether it is the active slave, the MAC hashes assigned to
 154 the slave, and the MAC learning table entries that hash to each MAC.
 155 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 156 Assigns a given MAC hash to a new slave.  \fIport\fR specifies the
 157 bond port, \fIhash\fR either the MAC hash to be migrated (as a decimal
 158 number between 0 and 255) or an Ethernet address to be hashed, and
 159 \fIslave\fR the new slave to be assigned.
 160 .IP
 161 The reassignment is not permanent: rebalancing or fail-over will
 162 cause the MAC hash to be shifted to a new slave in the usual
 163 manner.
 164 .IP
 165 A MAC hash cannot be migrated to a disabled slave.
 166 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 167 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 168 currently be enabled.
 169 .IP
 170 The setting is not permanent: a new active slave will be selected
 171 if \fIslave\fR becomes disabled.
 172 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 173 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 174 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 175 updelay (or downdelay).
 176 .IP
 177 This setting is not permanent: it persists only until the carrier
 178 status of \fIslave\fR changes.
 179 .IP "\fBbond/hash\fR \fImac\fR"
 180 Returns the hash value which would be used for \fImac\fR.
 181 .
 182 .so lib/vlog-unixctl.man
 183 .SH "SEE ALSO"
 184 .BR ovs\-appctl (8),
 185 .BR ovs\-brcompatd (8),
 186 .BR ovsdb\-server (1),
 187 \fBINSTALL.Linux\fR in the Open vSwitch distribution.