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