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 .B ovs\-vswitchd
  18 \fIdatabase\fR
  19 .
  20 .SH DESCRIPTION
  21 A daemon that manages and controls any number of Open vSwitch switches
  22 on the local machine.
  23 .PP
  24 The mandatory \fIdatabase\fR argument normally takes the form
  25 \fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain
  26 socket on which \fBovsdb\-server\fR is listening.  However, all of the
  27 following forms are accepted:
  28 .so ovsdb/remote-active.man
  29 .so ovsdb/remote-passive.man
  30 .PP
  31 \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at
  32 startup.  It sets up Open vSwitch datapaths and then operates
  33 switching across each bridge described in its configuration files.  As
  34 the database changes, \fBovs\-vswitchd\fR automatically updates its
  35 configuration to match.
  36 .PP
  37 Upon receipt of a SIGHUP signal, \fBovs\-vswitchd\fR reopens its log
  38 file, if one was specified on the command line.
  39 .PP
  40 \fBovs\-vswitchd\fR switches may be configured with any of the following
  41 features:
  42 .
  43 .IP \(bu
  44 L2 switching with MAC learning.
  45 .
  46 .IP \(bu
  47 NIC bonding with automatic fail-over and source MAC-based TX load
  48 balancing ("SLB").
  49 .
  50 .IP \(bu
  51 802.1Q VLAN support.
  52 .
  53 .IP \(bu
  54 Port mirroring, with optional VLAN tagging.
  55 .
  56 .IP \(bu
  57 NetFlow v5 flow logging.
  58 .
  59 .IP \(bu
  60 sFlow(R) monitoring.
  61 .
  62 .IP \(bu
  63 Connectivity to an external OpenFlow controller, such as NOX.
  64 .
  65 .PP
  66 Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
  67 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
  68 to the maximum number of supported Open vSwitch datapaths.
  69 .PP
  70 \fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR,
  71 and more.  Do not run both daemons at the same time.
  72 .PP
  73 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
  74 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
  75 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
  76 to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
  77 its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
  78 .PP
  79 An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
  80 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
  81 Open vSwitch distribution for instructions on how to build and load
  82 the Open vSwitch kernel module.
  83 .PP
  84 .SH OPTIONS
  85 .IP "\fB\-\-mlockall\fR"
  86 Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to
  87 attempt to lock all of its process memory into physical RAM,
  88 preventing the kernel from paging any of its memory to disk.  This
  89 helps to avoid networking interruptions due to system memory pressure.
  90 .IP
  91 Some systems do not support \fBmlockall()\fR at all, and other systems
  92 only allow privileged users, such as the superuser, to use it.
  93 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
  94 unavailable or unsuccessful.
  95 .
  96 .ds DD \
  97 \fBovs\-vswitchd\fR detaches only after it has connected to the \
  98 database, retrieved the initial configuration, and set up that \
  99 configuration.
 100 .so lib/daemon.man
 101 .SS "Public Key Infrastructure Options"
 102 .so lib/ssl.man
 103 .so lib/ssl-bootstrap.man
 104 .so lib/vlog.man
 105 .so lib/common.man
 106 .so lib/leak-checker.man
 107 .
 108 .SH "RUNTIME MANAGEMENT COMMANDS"
 109 \fBovs\-appctl\fR(8) can send commands to a running
 110 \fBovs\-vswitchd\fR process.  The currently supported commands are
 111 described below.  The command descriptions assume an understanding of
 112 how to configure Open vSwitch.
 113 .SS "GENERAL COMMANDS"
 114 .IP "\fBexit\fR"
 115 Causes \fBovs\-vswitchd\fR to gracefully terminate.
 116 .IP "\fBqos/show\fR \fIinterface\fR"
 117 Queries the kernel for Quality of Service configuration and statistics
 118 associated with the given \fIinterface\fR.
 119 .IP "\fBcfm/show\fR \fIinterface\fR"
 120 Displays detailed information about Connectivity Fault Management
 121 configured on \fIinterface\fR.
 122 .SS "BRIDGE COMMANDS"
 123 These commands manage bridges.
 124 .IP "\fBfdb/show\fR \fIbridge\fR"
 125 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
 126 along with the port on which it was learned and the age of the entry,
 127 in seconds.
 128 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
 129 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
 130 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
 131 their controller connections and reconnect.
 132 .IP
 133 This command might be useful for debugging OpenFlow controller issues.
 134 .
 135 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
 136 Lists all flows in \fIbridge\fR, including those normally hidden to
 137 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
 138 such as in-band control and fail-open are hidden from the controller
 139 since it is not allowed to modify or override them.
 140 .SS "BOND COMMANDS"
 141 These commands manage bonded ports on an Open vSwitch's bridges.  To
 142 understand some of these commands, it is important to understand a
 143 detail of the bonding implementation called ``source load balancing''
 144 (SLB).  Instead of directly assigning Ethernet source addresses to
 145 slaves, the bonding implementation computes a function that maps an
 146 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
 147 value).  All of the Ethernet addresses that map to a single 8-bit
 148 value are then assigned to a single slave.
 149 .IP "\fBbond/list\fR"
 150 Lists all of the bonds, and their slaves, on each bridge.
 151 .
 152 .IP "\fBbond/show\fR \fIport\fR"
 153 Lists all of the bond-specific information about the given bonded
 154 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
 155 lists information about each slave: whether it is enabled or disabled,
 156 the time to completion of an updelay or downdelay if one is in
 157 progress, whether it is the active slave, the MAC hashes assigned to
 158 the slave, and the MAC learning table entries that hash to each MAC.
 159 Any LACP information related to this bond may be found using the
 160 \fBlacp/show\fR command.
 161 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 162 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
 163 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
 164 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
 165 new slave to be assigned.
 166 .IP
 167 The reassignment is not permanent: rebalancing or fail-over will
 168 cause the MAC hash to be shifted to a new slave in the usual
 169 manner.
 170 .IP
 171 A MAC hash cannot be migrated to a disabled slave.
 172 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
 173 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
 174 currently be enabled.
 175 .IP
 176 The setting is not permanent: a new active slave will be selected
 177 if \fIslave\fR becomes disabled.
 178 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
 179 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
 180 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
 181 updelay (or downdelay).
 182 .IP
 183 This setting is not permanent: it persists only until the carrier
 184 status of \fIslave\fR changes.
 185 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]"
 186 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
 187 and \fIbasis\fR if specified.
 188 .
 189 .IP "\fBlacp/show\fR \fIport\fR"
 190 Lists all of the LACP related information about the given \fIport\fR:
 191 active or passive, aggregation key, system id, and system priority.  Also
 192 lists information about each slave: whether it is enabled or disabled,
 193 whether it is attached or detached, port id and priority, actor
 194 information, and partner information.
 195 .
 196 .so ofproto/ofproto-unixctl.man
 197 .so lib/vlog-unixctl.man
 198 .so lib/stress-unixctl.man
 199 .SH "SEE ALSO"
 200 .BR ovs\-appctl (8),
 201 .BR ovs\-brcompatd (8),
 202 .BR ovsdb\-server (1),
 203 \fBINSTALL.Linux\fR in the Open vSwitch distribution.