X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fovs-vswitchd.8.in;h=9d66a61c7d6d15a1fb100efe565fdaf0f8c9c5b3;hb=5ca1ba484bd9ade5116a49cf241cb98219d7d696;hp=f0badf0dad042ed80fa084ab6377d10a82257649;hpb=0b8b6f71d5621a726a3bf5aa1bbee27ed1f4a8fe;p=sliver-openvswitch.git diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index f0badf0da..9d66a61c7 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -14,17 +14,15 @@ ovs\-vswitchd \- Open vSwitch daemon . .SH SYNOPSIS -.B ovs\-vswitchd -\fIdatabase\fR +\fBovs\-vswitchd \fR[\fIdatabase\fR] . .SH DESCRIPTION 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 -\fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain -socket on which \fBovsdb\-server\fR is listening. However, all of the -following forms are accepted: +The \fIdatabase\fR argument specifies how \fBovs\-vswitchd\fR connects +to \fBovsdb\-server\fR. The default is \fBunix:@RUNDIR@/db.sock\fR. +The following forms are accepted: .so ovsdb/remote-active.man .so ovsdb/remote-passive.man .PP @@ -67,9 +65,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 @@ -113,8 +108,28 @@ 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. If \fIinterface\fR is not specified, +then displays detailed information about all interfaces with CFM +enabled. +.IP "\fBcfm/set-fault\fR [\fIinterface\fR] \fIstatus\fR" +Force the fault status of the CFM module on \fIinterface\fR (or all +interfaces if none is given) to be \fIstatus\fR. \fIstatus\fR can be +"true", "false", or "normal" which reverts to the standard behavior. +.IP "\fBstp/tcn\fR [\fIbridge\fR]" +Forces a topology change event on \fIbridge\fR if it's running STP. This +may cause it to send Topology Change Notifications to its peers and flush +its MAC table.. If no \fIbridge\fR is given, forces a topology change +event on all bridges. .SS "BRIDGE COMMANDS" These commands manage bridges. +.IP "\fBfdb/flush\fR [\fIbridge\fR]" +Flushes \fIbridge\fR MAC address learning table, or all learning tables +if no \fIbridge\fR is given. .IP "\fBfdb/show\fR \fIbridge\fR" Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR, along with the port on which it was learned and the age of the entry, @@ -143,13 +158,15 @@ value are then assigned to a single slave. .IP "\fBbond/list\fR" Lists all of the bonds, and their slaves, on each bridge. . -.IP "\fBbond/show\fR \fIport\fR" -Lists all of the bond-specific information about the given bonded -\fIport\fR: updelay, downdelay, time until the next rebalance. Also -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. +.IP "\fBbond/show\fR [\fIport\fR]" +Lists all of the bond-specific information (updelay, downdelay, time +until the next rebalance) about the given bonded \fIport\fR, or all +bonded ports if no \fIport\fR is given. Also 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 hashes assigned to the slave. 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" 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 @@ -174,15 +191,68 @@ 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 [\fIvlan\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 -if specified. +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. If \fIport\fR is not specified, +then displays detailed information about all interfaces with CFM +enabled. +. +.so ofproto/ofproto-dpif-unixctl.man .so ofproto/ofproto-unixctl.man .so lib/vlog-unixctl.man +.so lib/memory-unixctl.man .so lib/stress-unixctl.man +. +.SH "LIMITS" +. +.PP +We believe these limits to be accurate as of this writing. These +limits assume the use of the Linux kernel datapath. +. +.IP \(bu +Approximately 256 bridges given the allowance of 5,000 file +descriptors that \fBovs\-ctl\fR(8) configures. (\fBovs\-vswitchd\fR +requires 17 file descriptors per datapath.) +. +.IP \(bu +65,280 ports per bridge. Performance will degrade beyond 1,024 ports +per bridge due to fixed hash table sizing. +. +.IP \(bu +2,048 MAC learning entries per bridge. +. +.IP \(bu +Kernel flows are limited only by memory available to the kernel. +Performance will degrade beyond 1,048,576 kernel flows per bridge with +a 32-bit kernel, beyond 262,144 with a 64-bit kernel. +(\fBovs\-vswitchd\fR should never install anywhere near that many +flows.) +. +.IP \(bu +OpenFlow flows are limited only by available memory. Performance is +linear in the number of unique wildcard patterns. That is, an +OpenFlow table that contains many flows that all match on the same +fields in the same way has a constant-time lookup, but a table that +contains many flows that match on different fields requires lookup +time linear in the number of flows. +. +.IP \(bu +255 ports per bridge participating in 802.1D Spanning Tree Protocol. +. +.IP \(bu +32 mirrors per bridge. +. +.IP \(bu +15 bytes for the name of a port. (This is a Linux kernel limitation.) +. .SH "SEE ALSO" .BR ovs\-appctl (8), -.BR ovs\-brcompatd (8), .BR ovsdb\-server (1), \fBINSTALL.Linux\fR in the Open vSwitch distribution.