datapath: Report ifindex of 0 if vport doesn't have one.

[sliver-openvswitch.git] / vswitchd / ovs-vswitchd.8.in

diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
index b7c9940..822c0f2 100644 (file)
--- a/vswitchd/ovs-vswitchd.8.in
+++ b/vswitchd/ovs-vswitchd.8.in
@@ -5,7 +5,10 @@
 .  IP "\\$1"
 ..
 .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
 .  IP "\\$1"
 ..
 .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"

+.\" This program's name:

 .ds PN ovs\-vswitchd
 .ds PN ovs\-vswitchd

+.\" SSL peer program's name:
+.ds SN ovs\-controller

 .
 .SH NAME
 ovs\-vswitchd \- Open vSwitch daemon
 .
 .SH NAME
 ovs\-vswitchd \- Open vSwitch daemon


@@ -15,12 +18,13 @@ ovs\-vswitchd \- Open vSwitch daemon
 \fIdatabase\fR
 .
 .SH DESCRIPTION
 \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
 on the local machine.
 .PP

-The mandatory \fIdatabase\fR argument specifies the
-\fBovsdb\-server\fR from which \fBovs\-vswitchd\fR's configuration
-should be retrieved.  It takes one of the following forms:
+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
 .so ovsdb/remote-active.man
 .so ovsdb/remote-passive.man
 .PP


@@ -33,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
 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
 features:
 .
 .IP \(bu


@@ -63,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
 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
 \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


@@ -75,7 +82,7 @@ Open vSwitch distribution for instructions on how to build and load
 the Open vSwitch kernel module.
 .PP
 .SH OPTIONS
 the Open vSwitch kernel module.
 .PP
 .SH OPTIONS

-.IP "\fB--mlockall\fR"
+.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
 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


@@ -86,12 +93,14 @@ 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.
 .
 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
 unavailable or unsuccessful.
 .

-.IP "\fB--fake-proc-net\fR"
+.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.
 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.

 .
 .so lib/daemon.man
 .SS "Public Key Infrastructure Options"
 .
 .so lib/daemon.man
 .SS "Public Key Infrastructure Options"


@@ -106,16 +115,25 @@ to be loaded.
 \fBovs\-vswitchd\fR process.  The currently supported commands are
 described below.  The command descriptions assume an understanding of
 how to configure Open vSwitch.
 \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.

 .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.
 .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.

 .
 .

-.IP "\fBbridge/dump-flows\fR \fIbridge\fR"
+.IP "\fBbridge/dump\-flows\fR \fIbridge\fR"

 Lists all flows in \fIbridge\fR, including those normally hidden to
 Lists all flows in \fIbridge\fR, including those normally hidden to

-commands such as \fBovs-ofctl dump-flows\fR.  Flows set up by mechanisms
+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"
 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"


@@ -139,32 +157,35 @@ 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/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
 Assigns a given MAC hash to a new slave.  \fIport\fR specifies the
 the slave, and the MAC learning table entries that hash to each MAC.
 .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.
+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
 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"
+.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.
 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"
+.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.
 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"
-Returns the hash value which would be used for \fImac\fR.
+.IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR]"
+Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
+if specified.

 .
 .

+.so ofproto/ofproto-unixctl.man

 .so lib/vlog-unixctl.man
 .so lib/vlog-unixctl.man

+.so lib/stress-unixctl.man

 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-brcompatd (8),
 .SH "SEE ALSO"
 .BR ovs\-appctl (8),
 .BR ovs\-brcompatd (8),