ovs-openflowd: Rename test-openflowd and move to "tests" directory.
[sliver-openvswitch.git] / vswitchd / ovs-vswitchd.8.in
index e59893f..3e41bab 100644 (file)
@@ -18,7 +18,7 @@ ovs\-vswitchd \- Open vSwitch daemon
 \fIdatabase\fR
 .
 .SH DESCRIPTION
-A daemon that manages and controls any number of Open vSwitch switches 
+A daemon that manages and controls any number of Open vSwitch switches
 on the local machine.
 .PP
 The mandatory \fIdatabase\fR argument normally takes the form
@@ -37,7 +37,7 @@ configuration to match.
 Upon receipt of a SIGHUP signal, \fBovs\-vswitchd\fR reopens its log
 file, if one was specified on the command line.
 .PP
-\fBovs\-vswitchd\fR switches may be configured with any of the following 
+\fBovs\-vswitchd\fR switches may be configured with any of the following
 features:
 .
 .IP \(bu
@@ -67,9 +67,6 @@ Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
 to the maximum number of supported Open vSwitch datapaths.
 .PP
-\fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR,
-and more.  Do not run both daemons at the same time.
-.PP
 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
 itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
 managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
@@ -93,15 +90,10 @@ only allow privileged users, such as the superuser, to use it.
 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
 unavailable or unsuccessful.
 .
-.IP "\fB\-\-fake\-proc\-net\fR"
-Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
-and \fB/proc/net/bonding\fR that some legacy software expects to
-exist.  This option should only be used if such legacy software is
-actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
-to be loaded.
-.IP
-On non-Linux hosts, this option is accepted but has no effect.
-.
+.ds DD \
+\fBovs\-vswitchd\fR detaches only after it has connected to the \
+database, retrieved the initial configuration, and set up that \
+configuration.
 .so lib/daemon.man
 .SS "Public Key Infrastructure Options"
 .so lib/ssl.man
@@ -118,6 +110,12 @@ how to configure Open vSwitch.
 .SS "GENERAL COMMANDS"
 .IP "\fBexit\fR"
 Causes \fBovs\-vswitchd\fR to gracefully terminate.
+.IP "\fBqos/show\fR \fIinterface\fR"
+Queries the kernel for Quality of Service configuration and statistics
+associated with the given \fIinterface\fR.
+.IP "\fBcfm/show\fR \fIinterface\fR"
+Displays detailed information about Connectivity Fault Management
+configured on \fIinterface\fR.
 .SS "BRIDGE COMMANDS"
 These commands manage bridges.
 .IP "\fBfdb/show\fR \fIbridge\fR"
@@ -139,12 +137,12 @@ since it is not allowed to modify or override them.
 .SS "BOND COMMANDS"
 These commands manage bonded ports on an Open vSwitch's bridges.  To
 understand some of these commands, it is important to understand a
-detail of the bonding implementation called ``MAC hashing.''  Instead
-of directly assigning Ethernet source addresses to slaves, the bonding
-implementation computes a function that maps an 48-bit Ethernet source
-addresses into an 8-bit value (a ``MAC hash'' value).  All of the
-Ethernet addresses that map to a single 8-bit value are then assigned
-to a single slave.
+detail of the bonding implementation called ``source load balancing''
+(SLB).  Instead of directly assigning Ethernet source addresses to
+slaves, the bonding implementation computes a function that maps an
+48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
+value).  All of the Ethernet addresses that map to a single 8-bit
+value are then assigned to a single slave.
 .IP "\fBbond/list\fR"
 Lists all of the bonds, and their slaves, on each bridge.
 .
@@ -155,11 +153,13 @@ lists information about each slave: whether it is enabled or disabled,
 the time to completion of an updelay or downdelay if one is in
 progress, whether it is the active slave, the MAC hashes assigned to
 the slave, and the MAC learning table entries that hash to each MAC.
+Any LACP information related to this bond may be found using the
+\fBlacp/show\fR command.
 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
-Assigns a given MAC hash to a new slave.  \fIport\fR specifies the
-bond port, \fIhash\fR either the MAC hash to be migrated (as a decimal
-number between 0 and 255) or an Ethernet address to be hashed, and
-\fIslave\fR the new slave to be assigned.
+Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
+\fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
+migrated (as a decimal number between 0 and 255), and \fIslave\fR the
+new slave to be assigned.
 .IP
 The reassignment is not permanent: rebalancing or fail-over will
 cause the MAC hash to be shifted to a new slave in the usual
@@ -179,10 +179,20 @@ updelay (or downdelay).
 .IP
 This setting is not permanent: it persists only until the carrier
 status of \fIslave\fR changes.
-.IP "\fBbond/hash\fR \fImac\fR"
-Returns the hash value which would be used for \fImac\fR.
+.IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR] [\fIbasis\fR]"
+Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
+and \fIbasis\fR if specified.
+.
+.IP "\fBlacp/show\fR \fIport\fR"
+Lists all of the LACP related information about the given \fIport\fR:
+active or passive, aggregation key, system id, and system priority.  Also
+lists information about each slave: whether it is enabled or disabled,
+whether it is attached or detached, port id and priority, actor
+information, and partner information.
 .
+.so ofproto/ofproto-unixctl.man
 .so lib/vlog-unixctl.man
+.so lib/stress-unixctl.man
 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-brcompatd (8),