X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fovs-vswitchd.8.in;h=4c02f8a4b995b2e62eb3d2239c7407392126e221;hb=e51b8b03f936960d097fc642cb694d119829c054;hp=6941bdf5e51070afb831f4546764c8b6154f165c;hpb=8fef8c7121222233075a03d57db7e0b48d5f6be5;p=sliver-openvswitch.git diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index 6941bdf5e..4c02f8a4b 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -1,28 +1,43 @@ +.\" -*- nroff -*- +.de IQ +. br +. ns +. IP "\\$1" +.. .TH ovs\-vswitchd 8 "June 2009" "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 . .SH SYNOPSIS .B ovs\-vswitchd -\fIconfig\fR +\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 \fIconfig\fR argument specifies a configuration file. -For a description of \fBovs\-vswitchd\fR configuration syntax, see -\fBovs\-vswitchd.conf\fR(5). +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: +.so ovsdb/remote-active.man +.so ovsdb/remote-passive.man .PP -At startup or upon receipt of a \fBSIGHUP\fR signal, \fBovs\-vswitchd\fR -reads the configuration file. It sets up Open vSwitch datapaths and then -operates switching across each bridge described in its configuration -files. If a logfile was specified on the command line it will also -be opened or reopened. +\fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at +startup. It sets up Open vSwitch datapaths and then operates +switching across each bridge described in its configuration files. As +the database changes, \fBovs\-vswitchd\fR automatically updates its +configuration to match. .PP -\fBovs\-vswitchd\fR switches may be configured with any of the following +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: . .IP \(bu @@ -42,6 +57,9 @@ Port mirroring, with optional VLAN tagging. NetFlow v5 flow logging. . .IP \(bu +sFlow(R) monitoring. +. +.IP \(bu Connectivity to an external OpenFlow controller, such as NOX. . .PP @@ -49,6 +67,9 @@ 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 @@ -61,27 +82,122 @@ Open vSwitch distribution for instructions on how to build and load the Open vSwitch kernel module. .PP .SH OPTIONS -.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 "\fB\-\-mlockall\fR" +Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to +attempt to lock all of its process memory into physical RAM, +preventing the kernel from paging any of its memory to disk. This +helps to avoid networking interruptions due to system memory pressure. +.IP +Some systems do not support \fBmlockall()\fR at all, and other systems +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. . +.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 +.so lib/ssl-bootstrap.man .so lib/vlog.man .so lib/common.man .so lib/leak-checker.man . -.SH "BUGS" +.SH "RUNTIME MANAGEMENT COMMANDS" +\fBovs\-appctl\fR(8) can send commands to a running +\fBovs\-vswitchd\fR process. The currently supported commands are +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 "\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" +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 "\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 +their controller connections and reconnect. +.IP +This command might be useful for debugging OpenFlow controller issues. . -Only Open vSwitch kernel-based datapaths are currently supported. In the -future, this restriction may be lifted. -.PP -Only Linux 2.6.\fIx\fR is currently supported. +.IP "\fBbridge/dump\-flows\fR \fIbridge\fR" +Lists all flows in \fIbridge\fR, including those normally hidden to +commands such as \fBovs\-ofctl dump\-flows\fR. Flows set up by mechanisms +such as in-band control and fail-open are hidden from the controller +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 ``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. +. +.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. +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 +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 +manner. +.IP +A MAC hash cannot be migrated to a disabled slave. +.IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR" +Sets \fIslave\fR as the active slave on \fIport\fR. \fIslave\fR must +currently be enabled. +.IP +The setting is not permanent: a new active slave will be selected +if \fIslave\fR becomes disabled. +.IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR" +.IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR" +Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any +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]" +Returns the hash value which would be used for \fImac\fR with \fIvlan\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\-vswitchd.conf (5), .BR ovs\-brcompatd (8), +.BR ovsdb\-server (1), \fBINSTALL.Linux\fR in the Open vSwitch distribution.