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