X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=vswitchd%2Fovs-vswitchd.8.in;h=901f75e6f300f874d0529f8c94dd29108c5325f3;hb=7ed73428a675a174d629d694e483f81358dc907e;hp=1606b87274ab889dca79f50168b611716924c8d0;hpb=2be9d4f0a013419169970c998d9a864d020e93f0;p=mirror_ovs.git diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index 1606b8727..901f75e6f 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -1,14 +1,8 @@ .\" -*- nroff -*- -.de IQ -. br -. ns -. IP "\\$1" -.. +.so lib/ovs.tmac .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 @@ -21,10 +15,9 @@ A daemon that manages and controls any number of Open vSwitch switches on the local machine. .PP 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 +to \fBovsdb\-server\fR. \fIdatabase\fR may be an OVSDB active or +passive connection method, as described in \fBovsdb\fR(7). The +default is \fBunix:@RUNDIR@/db.sock\fR. .PP \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at startup. It sets up Open vSwitch datapaths and then operates @@ -32,9 +25,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: . @@ -65,16 +55,16 @@ 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 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 -to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with -its operation. (\fBovs\-dpctl\fR may still be useful for diagnostics.) +\fBovs\-vswitchd\fR does all the necessary management of Open vSwitch +datapaths itself. Thus, \fBovs\-dpctl\fR(8) (and its userspace +datapath counterparts accessible via \fBovs\-appctl +dpctl/\fIcommand\fR) are not needed with \fBovs\-vswitchd\fR and should +not be used because they can interfere with its operation. These +tools are still useful for diagnostics. .PP An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR -to be useful. Please refer to the \fBINSTALL.Linux\fR file included in the -Open vSwitch distribution for instructions on how to build and load -the Open vSwitch kernel module. +to be useful. Refer to the documentation for instructions on how to build and +load the Open vSwitch kernel module. .PP .SH OPTIONS .IP "\fB\-\-mlockall\fR" @@ -88,17 +78,27 @@ 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. . +.SS "DPDK Options" +For details on initializing the \fBovs\-vswitchd\fR DPDK datapath, +refer to the documentation or \fBovs\-vswitchd.conf.db\fR(5) for +details. +.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/ssl-peer-ca-cert.man +.SS "Logging Options" .so lib/vlog.man +.SS "Other Options" +.so lib/unixctl.man .so lib/common.man -.so lib/leak-checker.man . .SH "RUNTIME MANAGEMENT COMMANDS" \fBovs\-appctl\fR(8) can send commands to a running @@ -106,11 +106,26 @@ configuration. described below. The command descriptions assume an understanding of how to configure Open vSwitch. .SS "GENERAL COMMANDS" -.IP "\fBexit\fR" -Causes \fBovs\-vswitchd\fR to gracefully terminate. +.IP "\fBexit\fR \fI--cleanup\fR" +Causes \fBovs\-vswitchd\fR to gracefully terminate. If \fI--cleanup\fR +is specified, release datapath resources configured by \fBovs\-vswitchd\fR. +Otherwise, datapath flows and other resources remains undeleted. +. +.IP "\fBqos/show-types\fR \fIinterface\fR" +Queries the interface for a list of Quality of Service types that are +configurable via Open vSwitch for the given \fIinterface\fR. .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, @@ -123,8 +138,21 @@ interfaces if none is given) to be \fIstatus\fR. \fIstatus\fR can be .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 +its MAC table. If no \fIbridge\fR is given, forces a topology change +event on all bridges. +.IP "\fBstp/show\fR [\fIbridge\fR]" +Displays detailed information about spanning tree on the \fIbridge\fR. If +\fIbridge\fR is not specified, then displays detailed information about all +bridges with STP enabled. +.IP "\fBrstp/tcn\fR [\fIbridge\fR]" +Forces a topology change event on \fIbridge\fR if it's running RSTP. 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. +.IP "\fBrstp/show\fR [\fIbridge\fR]" +Displays detailed information about rapid spanning tree on the \fIbridge\fR. +If \fIbridge\fR is not specified, then displays detailed information about all +bridges with RSTP enabled. .SS "BRIDGE COMMANDS" These commands manage bridges. .IP "\fBfdb/flush\fR [\fIbridge\fR]" @@ -134,6 +162,18 @@ if no \fIbridge\fR is given. 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, in seconds. +.IP "\fBfdb/stats-clear\fR [\fIbridge\fR]" +Clear \fIbridge\fR MAC address learning table statistics, or all +statistics if no \fIbridge\fR is given. +.IP "\fBfdb/stats-show\fR \fIbridge\fR" +Show MAC address learning table statistics for the specified \fIbridge\fR. +.IP "\fBmdb/flush\fR [\fIbridge\fR]" +Flushes \fIbridge\fR multicast snooping table, or all snooping tables +if no \fIbridge\fR is given. +.IP "\fBmdb/show\fR \fIbridge\fR" +Lists each multicast group/VLAN pair learned by the specified \fIbridge\fR, +along with the port on which it was learned and the age of the entry, +in seconds. .IP "\fBbridge/reconnect\fR [\fIbridge\fR]" Makes \fIbridge\fR drop all of its OpenFlow controller connections and reconnect. If \fIbridge\fR is not specified, then all bridges drop @@ -204,12 +244,70 @@ information, and partner information. If \fIport\fR is not specified, then displays detailed information about all interfaces with CFM enabled. . +.IP "\fBlacp/stats-show\fR [\fIport\fR]" +Lists various stats about LACP PDUs (number of RX/TX PDUs, bad PDUs received) +and slave state (number of time slave's state expired/defaulted and carrier +status changed) for the given \fIport\fR. If \fIport\fR is not specified, +then displays stats of all interfaces with LACP enabled. +.SS "DPCTL DATAPATH DEBUGGING COMMANDS" +The primary way to configure \fBovs\-vswitchd\fR is through the Open +vSwitch database, e.g. using \fBovs\-vsctl\fR(8). These commands +provide a debugging interface for managing datapaths. They implement +the same features (and syntax) as \fBovs\-dpctl\fR(8). Unlike +\fBovs\-dpctl\fR(8), these commands work with datapaths that are +integrated into \fBovs\-vswitchd\fR (e.g. the \fBnetdev\fR datapath +type). +.PP +. +.ds DX \fBdpctl/\fR +.de DO +\\$2 \\$1 \\$3 +.. +.so lib/dpctl.man +. +.so lib/dpif-netdev-unixctl.man +.so lib/netdev-dpdk-unixctl.man .so ofproto/ofproto-dpif-unixctl.man .so ofproto/ofproto-unixctl.man .so lib/vlog-unixctl.man .so lib/memory-unixctl.man .so lib/coverage-unixctl.man -.so lib/stress-unixctl.man +.so ofproto/ofproto-tnl-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 does not maintains any packet buffers. +. +.SS "Bundle lifetime" +The OpenFlow specification, version 1.4, says: +. +.IP +If the switch does not receive any OFPT_BUNDLE_CONTROL or +OFPT_BUNDLE_ADD_MESSAGE message for an opened bundle_id for a switch +defined time greater than 1s, it may send an ofp_error_msg with +OFPET_BUNDLE_FAILED type and OFPBFC_TIMEOUT code. If the switch does +not receive any new message in a bundle apart from echo request and +replies for a switch defined time greater than 1s, it may send an +ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_TIMEOUT code. +. +.PP +Open vSwitch implements default idle bundle lifetime of 10 seconds. +(This is configurable via \fBother-config:bundle-idle-timeout\fR in +the \fBOpen_vSwitch\fR table. See \fBovs-vswitchd.conf.db\fR(5) +for details.) . .SH "LIMITS" . @@ -218,13 +316,13 @@ 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. +\fBovs\-vswitchd\fR started through \fBovs\-ctl\fR(8) provides a limit of 65535 +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 three file descriptors and adding a port consumes +"n-handler-threads" file descriptors per bridge port. 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 @@ -257,5 +355,4 @@ time linear in the number of flows. . .SH "SEE ALSO" .BR ovs\-appctl (8), -.BR ovsdb\-server (1), -\fBINSTALL.Linux\fR in the Open vSwitch distribution. +.BR ovsdb\-server (1).