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