X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fovs-vswitchd.8.in;h=817cec24edc88044b0e06fb7e595635b7ff2580f;hb=cfc50ae514f805dcd9c14589f21158185424daf6;hp=4fa707b1cb41f803c232571982f44ee10ddd03ec;hpb=96e466a3c6aebd4ac21ddad971f6a7886a948f91;p=sliver-openvswitch.git diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index 4fa707b1c..817cec24e 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -4,11 +4,9 @@ . ns . IP "\\$1" .. -.TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual" +.TH ovs\-vswitchd 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .\" This program's name: .ds PN ovs\-vswitchd -.\" SSL peer program's name: -.ds SN ovs\-controller . .SH NAME ovs\-vswitchd \- Open vSwitch daemon @@ -32,9 +30,6 @@ switching across each bridge described in its configuration files. As the database changes, \fBovs\-vswitchd\fR automatically updates its configuration to match. .PP -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 features: . @@ -88,17 +83,29 @@ 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\-\-enable\-of14\fR" +Specifying this option allows OpenFlow 1.4 to be used if it is enabled +through the \fBprotocols\fR column in the \fBController\fR. Without +this option, \fBovs\-vswitchd\fR will not use OpenFlow 1.4 even if it +is enabled that way. This option is present because OpenFlow 1.4 +support is not safe: the daemon will abort when certain unimplemented +features are tested. Thus, for now it is suitable only for +experimental use. When the support is implemented safely, this option +will be removed. +. +.SS "Daemon Options" .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 "Service Options" +.so lib/service.man .SS "Public Key Infrastructure Options" .so lib/ssl.man .so lib/ssl-bootstrap.man .so lib/vlog.man .so lib/common.man -.so lib/leak-checker.man . .SH "RUNTIME MANAGEMENT COMMANDS" \fBovs\-appctl\fR(8) can send commands to a running @@ -108,16 +115,32 @@ how to configure Open vSwitch. .SS "GENERAL COMMANDS" .IP "\fBexit\fR" Causes \fBovs\-vswitchd\fR to gracefully terminate. -.IP "\fBcoverage/log\fR" -Logs coverage counters at level warn. .IP "\fBqos/show\fR \fIinterface\fR" Queries the kernel for Quality of Service configuration and statistics associated with the given \fIinterface\fR. +.IP "\fBbfd/show\fR [\fIinterface\fR]" +Displays detailed information about Bidirectional Forwarding Detection +configured on \fIinterface\fR. If \fIinterface\fR is not specified, +then displays detailed information about all interfaces with BFD +enabled. +.IP "\fBbfd/set-forwarding\fR [\fIinterface\fR] \fIstatus\fR" +Force the fault status of the BFD 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 "\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]" @@ -197,11 +220,76 @@ 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/stress-unixctl.man +.so lib/memory-unixctl.man +.so lib/coverage-unixctl.man +. +.SH "OPENFLOW IMPLEMENTATION" +. +.PP +This section documents aspects of OpenFlow for which the OpenFlow +specification requires documentation. +. +.SS "Packet buffering." +The OpenFlow specification, version 1.2, says: +. +.IP +Switches that implement buffering are expected to expose, through +documentation, both the amount of available buffering, and the length +of time before buffers may be reused. +. +.PP +Open vSwitch maintains a separate set of 256 packet buffers for each +OpenFlow connection. Any given packet buffer is preserved until it is +referenced by an \fBOFPT_FLOW_MOD\fR or \fBOFPT_PACKET_OUT\fR request +or for 5 seconds, whichever comes first. +. +.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 +\fBovs\-vswitchd\fR started through \fBovs\-ctl\fR(8) provides a limit of 7500 +file descriptors. The limits on the number of bridges and ports is decided by +the availability of file descriptors. With the Linux kernel datapath, creation +of a single bridge consumes 3 file descriptors and adding a port consumes +1 file descriptor. Performance will degrade beyond 1,024 ports per bridge due +to fixed hash table sizing. Other platforms may have different limitations. +. +.IP \(bu +2,048 MAC learning entries per bridge, by default. (This is +configurable via \fBother\-config:mac\-table\-size\fR in the +\fBBridge\fR table. See \fBovs\-vswitchd.conf.db\fR(5) for details.) +. +.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.