vswitchd/ovs-vswitchd.8.in

   1 .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
   2 .ds PN ovs\-vswitchd
   3 .
   4 .SH NAME
   5 ovs\-vswitchd \- Open vSwitch daemon
   6 .
   7 .SH SYNOPSIS
   8 .B ovs\-vswitchd
   9 \fIconfig\fR
  10 .
  11 .SH DESCRIPTION
  12 A daemon that manages and controls any number of Open vSwitch switches
  13 on the local machine.
  14 .PP
  15 The mandatory \fIconfig\fR argument specifies a configuration file.
  16 For a description of \fBovs\-vswitchd\fR configuration syntax, see
  17 \fBovs\-vswitchd.conf\fR(5).
  18 .PP
  19 At startup or upon receipt of a \fBSIGHUP\fR signal, \fBovs\-vswitchd\fR
  20 reads the configuration file.  It sets up Open vSwitch datapaths and then
  21 operates switching across each bridge described in its configuration
  22 files.  If a logfile was specified on the command line it will also
  23 be opened or reopened.
  24 .PP
  25 \fBovs\-vswitchd\fR switches may be configured with any of the following
  26 features:
  27 .
  28 .IP \(bu
  29 L2 switching with MAC learning.
  30 .
  31 .IP \(bu
  32 NIC bonding with automatic fail-over and source MAC-based TX load
  33 balancing ("SLB").
  34 .
  35 .IP \(bu
  36 802.1Q VLAN support.
  37 .
  38 .IP \(bu
  39 Port mirroring, with optional VLAN tagging.
  40 .
  41 .IP \(bu
  42 NetFlow v5 flow logging.
  43 .
  44 .IP \(bu
  45 Connectivity to an external OpenFlow controller, such as NOX.
  46 .
  47 .PP
  48 Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
  49 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
  50 to the maximum number of supported Open vSwitch datapaths.
  51 .PP
  52 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
  53 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  54 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  55 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  56 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  57 .PP
  58 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  59 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  60 Open vSwitch distribution for instructions on how to build and load
  61 the Open vSwitch kernel module.
  62 .PP
  63 .SH OPTIONS
  64 .IP "\fB--fake-proc-net\fR"
  65 Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
  66 and \fB/proc/net/bonding\fR that some legacy software expects to
  67 exist.  This option should only be used if such legacy software is
  68 actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
  69 to be loaded.
  70 .
  71 .so lib/daemon.man
  72 .so lib/vlog.man
  73 .so lib/common.man
  74 .so lib/leak-checker.man
  75 .
  76 .SH "RUNTIME MANAGEMENT COMMANDS"
  77 \fBovs\-appctl\fR(8) can send commands to a running
  78 \fBovs\-vswitchd\fR process.  The currently supported commands are
  79 described below.  The command descriptions assume an understanding of
  80 how to configure Open vSwitch, as described in
  81 \fBovs-vswitchd.conf\fR(5).
  82 .SS "OVS\-VSWITCHD COMMANDS"
  83 These commands manage the \fBovs-vswitchd\fR process.
  84 .IP "\fBvswitchd/reload\fR"
  85 Reloads the \fBovs\-vswitchd\fR configuration file, as if a
  86 \fBSIGHUP\fR signal were received.  The command completes only after
  87 reloading is finished, in particular after all datapaths have been
  88 created and destroyed and ports added and removed as specified by the
  89 new configuration.
  90 .SS "BRIDGE COMMANDS"
  91 These commands manage bridges.
  92 .IP "\fBfdb/show\fR \fIbridge\fR"
  93 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
  94 along with the port on which it was learned and the age of the entry,
  95 in seconds.
  96 .SS "BOND COMMANDS"
  97 These commands manage bonded ports on an Open vSwitch's bridges.  To
  98 understand some of these commands, it is important to understand a
  99 detail of the bonding implementation called ``MAC hashing.''  Instead
 100 of directly assigning Ethernet source addresses to slaves, the bonding
 101 implementation computes a function that maps an 48-bit Ethernet source
 102 addresses into an 8-bit value (a ``MAC hash'' value).  All of the
 103 Ethernet addresses that map to a single 8-bit value are then assigned
 104 to a single slave.
 105 .IP "\fBbond/list\fR"
 106 Lists all of the bonds, and their slaves, on each bridge.
 107 .
 108 .IP "\fBbond/show\fR \fIport\fR"
 109 Lists all of the bond-specific information about the given bonded
 110 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
 111 lists information about each slave: whether it is enabled or disabled,
 112 the time to completion of an updelay or downdelay if one is in
 113 progress, whether it is the active slave, the MAC hashes assigned to
 114 the slave, and the MAC learning table entries that hash to each MAC.
 115 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 116 Assigns a given MAC hash to a new slave.  \fIport\fR specifies the
 117 bond port, \fIhash\fR either the MAC hash to be migrated (as a decimal
 118 number between 0 and 255) or an Ethernet address to be hashed, and
 119 \fIslave\fR the new slave to be assigned.
 120 .IP
 121 The reassignment is not permanent: rebalancing or fail-over will
 122 cause the MAC hash to be shifted to a new slave in the usual
 123 manner.
 124 .IP
 125 A MAC hash cannot be migrated to a disabled slave.
 126 .IP "\fBbond/set-active-slave\fR \fIport\fR \fIslave\fR"
 127 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 128 currently be enabled.
 129 .IP
 130 The setting is not permanent: a new active slave will be selected
 131 if \fIslave\fR becomes disabled.
 132 .IP "\fBbond/enable-slave\fR \fIport\fR \fIslave\fR"
 133 .IQ "\fBbond/disable-slave\fR \fIport\fR \fIslave\fR"
 134 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 135 updelay (or downdelay).
 136 .IP
 137 This setting is not permanent: it persists only until the carrier
 138 status of \fIslave\fR changes.
 139 .
 140 .so lib/vlog-unixctl.man
 141 .SH "SEE ALSO"
 142 .BR ovs\-appctl (8),
 143 .BR ovs\-vswitchd.conf (5),
 144 .BR ovs\-brcompatd (8),
 145 \fBINSTALL.Linux\fR in the Open vSwitch distribution.