pintos-os.org Git - openvswitch/blob - 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 .\" This program's name:
   9 .ds PN ovs\-vswitchd
  10 .\" SSL peer program's name:
  11 .ds SN ovs\-controller
  12 .
  13 .SH NAME
  14 ovs\-vswitchd \- Open vSwitch daemon
  15 .
  16 .SH SYNOPSIS
  17 \fBovs\-vswitchd \fR[\fIdatabase\fR]
  18 .
  19 .SH DESCRIPTION
  20 A daemon that manages and controls any number of Open vSwitch switches
  21 on the local machine.
  22 .PP
  23 The \fIdatabase\fR argument specifies how \fBovs\-vswitchd\fR connects
  24 to \fBovsdb\-server\fR.  The default is \fBunix:@RUNDIR@/db.sock\fR.
  25 The following forms are accepted:
  26 .so ovsdb/remote-active.man
  27 .so ovsdb/remote-passive.man
  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 sFlow(R) monitoring.
  59 .
  60 .IP \(bu
  61 Connectivity to an external OpenFlow controller, such as NOX.
  62 .
  63 .PP
  64 Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
  65 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
  66 to the maximum number of supported Open vSwitch datapaths.
  67 .PP
  68 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
  69 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  70 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  71 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  72 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  73 .PP
  74 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  75 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  76 Open vSwitch distribution for instructions on how to build and load
  77 the Open vSwitch kernel module.
  78 .PP
  79 .SH OPTIONS
  80 .IP "\fB\-\-mlockall\fR"
  81 Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
  82 attempt to lock all of its process memory into physical RAM,
  83 preventing the kernel from paging any of its memory to disk.  This
  84 helps to avoid networking interruptions due to system memory pressure.
  85 .IP
  86 Some systems do not support \fBmlockall()\fR at all, and other systems
  87 only allow privileged users, such as the superuser, to use it.
  88 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
  89 unavailable or unsuccessful.
  90 .
  91 .ds DD \
  92 \fBovs\-vswitchd\fR detaches only after it has connected to the \
  93 database, retrieved the initial configuration, and set up that \
  94 configuration.
  95 .so lib/daemon.man
  96 .SS "Public Key Infrastructure Options"
  97 .so lib/ssl.man
  98 .so lib/ssl-bootstrap.man
  99 .so lib/vlog.man
 100 .so lib/common.man
 101 .so lib/leak-checker.man
 102 .
 103 .SH "RUNTIME MANAGEMENT COMMANDS"
 104 \fBovs\-appctl\fR(8) can send commands to a running
 105 \fBovs\-vswitchd\fR process.  The currently supported commands are
 106 described below.  The command descriptions assume an understanding of
 107 how to configure Open vSwitch.
 108 .SS "GENERAL COMMANDS"
 109 .IP "\fBexit\fR"
 110 Causes \fBovs\-vswitchd\fR to gracefully terminate.
 111 .IP "\fBcoverage/log\fR"
 112 Logs coverage counters at level warn.
 113 .IP "\fBqos/show\fR \fIinterface\fR"
 114 Queries the kernel for Quality of Service configuration and statistics
 115 associated with the given \fIinterface\fR.
 116 .IP "\fBcfm/show\fR [\fIinterface\fR]"
 117 Displays detailed information about Connectivity Fault Management
 118 configured on \fIinterface\fR.  If \fIinterface\fR is not specified,
 119 then displays detailed information about all interfaces with CFM
 120 enabled.
 121 .IP "\fBcfm/set-fault\fR [\fIinterface\fR] \fIstatus\fR"
 122 Force the fault status of the CFM module on \fIinterface\fR (or all
 123 interfaces if none is given) to be \fIstatus\fR.  \fIstatus\fR can be
 124 "true", "false", or "normal" which reverts to the standard behavior.
 125 .IP "\fBstp/tcn\fR [\fIbridge\fR]"
 126 Forces a topology change event on \fIbridge\fR if it's running STP.  This
 127 may cause it to send Topology Change Notifications to its peers and flush
 128 its MAC table..  If no \fIbridge\fR is given, forces a topology change
 129 event on all bridges.
 130 .SS "BRIDGE COMMANDS"
 131 These commands manage bridges.
 132 .IP "\fBfdb/flush\fR [\fIbridge\fR]"
 133 Flushes \fIbridge\fR MAC address learning table, or all learning tables
 134 if no \fIbridge\fR is given.
 135 .IP "\fBfdb/show\fR \fIbridge\fR"
 136 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 137 along with the port on which it was learned and the age of the entry,
 138 in seconds.
 139 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 140 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 141 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 142 their controller connections and reconnect.
 143 .IP
 144 This command might be useful for debugging OpenFlow controller issues.
 145 .
 146 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 147 Lists all flows in \fIbridge\fR, including those normally hidden to
 148 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 149 such as in-band control and fail-open are hidden from the controller
 150 since it is not allowed to modify or override them.
 151 .SS "BOND COMMANDS"
 152 These commands manage bonded ports on an Open vSwitch's bridges.  To
 153 understand some of these commands, it is important to understand a
 154 detail of the bonding implementation called ``source load balancing''
 155 (SLB).  Instead of directly assigning Ethernet source addresses to
 156 slaves, the bonding implementation computes a function that maps an
 157 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
 158 value).  All of the Ethernet addresses that map to a single 8-bit
 159 value are then assigned to a single slave.
 160 .IP "\fBbond/list\fR"
 161 Lists all of the bonds, and their slaves, on each bridge.
 162 .
 163 .IP "\fBbond/show\fR [\fIport\fR]"
 164 Lists all of the bond-specific information (updelay, downdelay, time
 165 until the next rebalance) about the given bonded \fIport\fR, or all
 166 bonded ports if no \fIport\fR is given.  Also lists information about
 167 each slave: whether it is enabled or disabled, the time to completion
 168 of an updelay or downdelay if one is in progress, whether it is the
 169 active slave, the hashes assigned to the slave.  Any LACP information
 170 related to this bond may be found using the \fBlacp/show\fR command.
 171 .
 172 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 173 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
 174 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
 175 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
 176 new slave to be assigned.
 177 .IP
 178 The reassignment is not permanent: rebalancing or fail-over will
 179 cause the MAC hash to be shifted to a new slave in the usual
 180 manner.
 181 .IP
 182 A MAC hash cannot be migrated to a disabled slave.
 183 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 184 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 185 currently be enabled.
 186 .IP
 187 The setting is not permanent: a new active slave will be selected
 188 if \fIslave\fR becomes disabled.
 189 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 190 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 191 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 192 updelay (or downdelay).
 193 .IP
 194 This setting is not permanent: it persists only until the carrier
 195 status of \fIslave\fR changes.
 196 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]"
 197 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
 198 and \fIbasis\fR if specified.
 199 .
 200 .IP "\fBlacp/show\fR [\fIport\fR]"
 201 Lists all of the LACP related information about the given \fIport\fR:
 202 active or passive, aggregation key, system id, and system priority.  Also
 203 lists information about each slave: whether it is enabled or disabled,
 204 whether it is attached or detached, port id and priority, actor
 205 information, and partner information.  If \fIport\fR is not specified,
 206 then displays detailed information about all interfaces with CFM
 207 enabled.
 208 .
 209 .so ofproto/ofproto-unixctl.man
 210 .so lib/vlog-unixctl.man
 211 .so lib/stress-unixctl.man
 212 .SH "SEE ALSO"
 213 .BR ovs\-appctl (8),
 214 .BR ovs\-brcompatd (8),
 215 .BR ovsdb\-server (1),
 216 \fBINSTALL.Linux\fR in the Open vSwitch distribution.