datapath: Use get_table_protected() in additional places.
[openvswitch] / utilities / ovs-openflowd.8.in
index 689ff5c73a36466153e21bf419434ee45083a24a..b84f8e7b78fc779b63b83467cc10ef5b31bf8ab5 100644 (file)
@@ -1,5 +1,8 @@
 .TH ovs\-openflowd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
 .TH ovs\-openflowd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
+.\" This program's name:
 .ds PN ovs\-openflowd
 .ds PN ovs\-openflowd
+.\" SSL peer program's name:
+.ds SN ovs\-controller
 .
 .SH NAME
 ovs\-openflowd \- OpenFlow switch implementation
 .
 .SH NAME
 ovs\-openflowd \- OpenFlow switch implementation
@@ -13,6 +16,9 @@ The \fBovs\-openflowd\fR program implements an OpenFlow switch using a
 flow-based datapath.  \fBovs\-openflowd\fR connects to one or more
 OpenFlow controllers over TCP or SSL.
 .PP
 flow-based datapath.  \fBovs\-openflowd\fR connects to one or more
 OpenFlow controllers over TCP or SSL.
 .PP
+For a more powerful alternative to \fBovs\-openflowd\fR, see
+\fBovs\-vswitchd\fR(8).  Do not run both daemons at the same time.
+.PP
 The mandatory \fIdatapath\fR argument argument specifies the local datapath
 to relay.  It takes one of the following forms:
 .
 The mandatory \fIdatapath\fR argument argument specifies the local datapath
 to relay.  It takes one of the following forms:
 .
@@ -24,6 +30,11 @@ OpenFlow controller or controllers.  Each takes one of the following
 forms:
 .
 .so lib/vconn-active.man
 forms:
 .
 .so lib/vconn-active.man
+.IP "\fBnone\fR"
+Run without actively maintaining a connection to a remote OpenFlow
+controller.  (See the \fB\-\-listen\fR option, under \fBNetworking
+Options\fR below, for another way to make OpenFlow connections to the
+switch.)
 .
 .PP
 When multiple controllers are configured, \fBovs\-openflowd\fR
 .
 .PP
 When multiple controllers are configured, \fBovs\-openflowd\fR
@@ -167,7 +178,8 @@ the local port network device, and start the DHCP client afterward.
 .SS "OpenFlow Options"
 .TP
 \fB\-\-datapath\-id=\fIdpid\fR
 .SS "OpenFlow Options"
 .TP
 \fB\-\-datapath\-id=\fIdpid\fR
-Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits,
+Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits
+and may not be all-zero,
 as the datapath ID that the switch will use to identify itself to
 OpenFlow controllers.
 .IP
 as the datapath ID that the switch will use to identify itself to
 OpenFlow controllers.
 .IP
@@ -422,9 +434,21 @@ switching.
 .SS "Logging Options"
 .so lib/vlog.man
 .SS "Other Options"
 .SS "Logging Options"
 .so lib/vlog.man
 .SS "Other Options"
+.so lib/unixctl.man
 .so lib/common.man
 .so lib/leak-checker.man
 .
 .so lib/common.man
 .so lib/leak-checker.man
 .
+.SH "RUNTIME MANAGEMENT COMMANDS"
+\fBovs\-appctl\fR(8) can send commands to a running
+\fBovs\-openflowd\fR process.  The currently supported commands are
+described below.
+.SS "OVS\-OPENFLOWD COMMANDS"
+These commands are specific to \fBovs\-openflowd\fR.
+.IP "\fBexit\fR"
+Causes \fBovs\-openflowd\fR to gracefully terminate.
+.so ofproto/ofproto-unixctl.man
+.so lib/vlog-unixctl.man
+.
 .SH "SEE ALSO"
 .
 .BR ovs\-appctl (8),
 .SH "SEE ALSO"
 .
 .BR ovs\-appctl (8),