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 .so ovsdb/remote-active.man
  25 .PP
  26 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
  27 startup.  It sets up Open vSwitch datapaths and then operates
  28 switching across each bridge described in its configuration files.  As
  29 the database changes, \fBovs\-vswitchd\fR automatically updates its
  30 configuration to match.
  31 .PP
  32 Upon receipt of a SIGHUP signal, \fBovs\-vswitchd\fR reopens its log
  33 file, if one was specified on the command line.
  34 .PP
  35 \fBovs\-vswitchd\fR switches may be configured with any of the following
  36 features:
  37 .
  38 .IP \(bu
  39 L2 switching with MAC learning.
  40 .
  41 .IP \(bu
  42 NIC bonding with automatic fail-over and source MAC-based TX load
  43 balancing ("SLB").
  44 .
  45 .IP \(bu
  46 802.1Q VLAN support.
  47 .
  48 .IP \(bu
  49 Port mirroring, with optional VLAN tagging.
  50 .
  51 .IP \(bu
  52 NetFlow v5 flow logging.
  53 .
  54 .IP \(bu
  55 sFlow(R) monitoring.
  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 .SS "Public Key Infrastructure Options"
  86 .so lib/ssl.man
  87 .so lib/ssl-bootstrap.man
  88 .so lib/vlog.man
  89 .so lib/common.man
  90 .so lib/leak-checker.man
  91 .
  92 .SH "RUNTIME MANAGEMENT COMMANDS"
  93 \fBovs\-appctl\fR(8) can send commands to a running
  94 \fBovs\-vswitchd\fR process.  The currently supported commands are
  95 described below.  The command descriptions assume an understanding of
  96 how to configure Open vSwitch.
  97 .SS "BRIDGE COMMANDS"
  98 These commands manage bridges.
  99 .IP "\fBfdb/show\fR \fIbridge\fR"
 100 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 101 along with the port on which it was learned and the age of the entry,
 102 in seconds.
 103 .
 104 .IP "\fBbridge/dump-flows\fR \fIbridge\fR"
 105 Lists all flows in \fIbridge\fR, including those normally hidden to
 106 commands such as \fBovs-ofctl dump-flows\fR.  Flows set up by mechanisms
 107 such as in-band control and fail-open are hidden from the controller
 108 since it is not allowed to modify or override them.
 109 .SS "BOND COMMANDS"
 110 These commands manage bonded ports on an Open vSwitch's bridges.  To
 111 understand some of these commands, it is important to understand a
 112 detail of the bonding implementation called ``MAC hashing.''  Instead
 113 of directly assigning Ethernet source addresses to slaves, the bonding
 114 implementation computes a function that maps an 48-bit Ethernet source
 115 addresses into an 8-bit value (a ``MAC hash'' value).  All of the
 116 Ethernet addresses that map to a single 8-bit value are then assigned
 117 to a single slave.
 118 .IP "\fBbond/list\fR"
 119 Lists all of the bonds, and their slaves, on each bridge.
 120 .
 121 .IP "\fBbond/show\fR \fIport\fR"
 122 Lists all of the bond-specific information about the given bonded
 123 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
 124 lists information about each slave: whether it is enabled or disabled,
 125 the time to completion of an updelay or downdelay if one is in
 126 progress, whether it is the active slave, the MAC hashes assigned to
 127 the slave, and the MAC learning table entries that hash to each MAC.
 128 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 129 Assigns a given MAC hash to a new slave.  \fIport\fR specifies the
 130 bond port, \fIhash\fR either the MAC hash to be migrated (as a decimal
 131 number between 0 and 255) or an Ethernet address to be hashed, and
 132 \fIslave\fR the new slave to be assigned.
 133 .IP
 134 The reassignment is not permanent: rebalancing or fail-over will
 135 cause the MAC hash to be shifted to a new slave in the usual
 136 manner.
 137 .IP
 138 A MAC hash cannot be migrated to a disabled slave.
 139 .IP "\fBbond/set-active-slave\fR \fIport\fR \fIslave\fR"
 140 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 141 currently be enabled.
 142 .IP
 143 The setting is not permanent: a new active slave will be selected
 144 if \fIslave\fR becomes disabled.
 145 .IP "\fBbond/enable-slave\fR \fIport\fR \fIslave\fR"
 146 .IQ "\fBbond/disable-slave\fR \fIport\fR \fIslave\fR"
 147 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 148 updelay (or downdelay).
 149 .IP
 150 This setting is not permanent: it persists only until the carrier
 151 status of \fIslave\fR changes.
 152 .IP "\fBbond/hash\fR \fImac\fR"
 153 Returns the hash value which would be used for \fImac\fR.
 154 .
 155 .so lib/vlog-unixctl.man
 156 .SH "SEE ALSO"
 157 .BR ovs\-appctl (8),
 158 .BR ovs\-brcompatd (8),
 159 .BR ovsdb\-server (1),
 160 \fBINSTALL.Linux\fR in the Open vSwitch distribution.