mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
Code Issues Releases Wiki Activity
ovs/utilities/ovs-controller.8.in

146 lines
5.0 KiB
Groff
Raw Normal View History

ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.\" -*- nroff -*-
.de IQ
. br
. ns
. IP "\\$1"
..
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TH ovs\-controller 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
.ds PN ovs\-controller
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH NAME
ovs\-controller \- simple OpenFlow controller reference implementation
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH SYNOPSIS
.B ovs\-controller
[\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&...
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH DESCRIPTION
\fBovs\-controller\fR manages any number of remote switches over OpenFlow
protocol, causing them to function as L2 MAC-learning switches or hub.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.PP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
\fBovs\-controller\fR controls one or more OpenFlow switches, specified as
one or more of the following OpenFlow connection methods:
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Factor vconn and SSL documentation into manpage include files.
2009-12-21 13:10:55 -08:00
.RS
.so lib/vconn-passive.man
.so lib/vconn-active.man
.RE
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH OPTIONS
ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.IP "\fB\-n\fR"
.IQ "\fB\-\-noflow\fR"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch
whenever it receives a packet whose destination is known due through
MAC learning. This option disables flow setup, so that every packet
in the network passes through the controller.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
This option is most useful for debugging. It reduces switching
performance, so it should not be used in production.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Sets \fIsecs\fR as the number of seconds that a flow set up by the
controller will remain in the switch's flow table without any matching
packets being seen. If \fBpermanent\fR is specified, which is not
recommended, flows will never expire. The default is 60 seconds.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
This option affects only flows set up by the OpenFlow controller. In
some configurations, the switch can set up some flows
on its own. To set the idle time for those flows, pass
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-max\-idle\fR to \fBovs\-openflowd\fR (on the switch).
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
(because the controller does not set up flows in that case).
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.IP "\fB\-H\fR"
.IQ "\fB\-\-hub\fR"
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
By default, the controller acts as an L2 MAC-learning switch. This
option changes its behavior to that of a hub that floods packets on
all but the incoming port.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
If \fB\-H\fR (or \fB\-\-hub\fR) and \fB\-n\fR (or \fB\-\-noflow\fR) are used
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
together, then the cumulative effect is that every packet passes
through the controller and every packet is flooded.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
This option is most useful for debugging. It reduces switching
performance, so it should not be used in production.
ovs-controller: Add --wildcard and --normal features. This adds two command line switches to ovs-controller to: 1) Use wildcards instead of exact matches. 2) Use "normal" action instead of explicit port.
2009-11-19 12:48:32 -08:00
.
ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.IP "\fB\-w\fR"
.IQ "\fB\-\-wildcard\fR"
ovs-controller: Add --wildcard and --normal features. This adds two command line switches to ovs-controller to: 1) Use wildcards instead of exact matches. 2) Use "normal" action instead of explicit port.
2009-11-19 12:48:32 -08:00
By default, \fBovs\-controller\fR sets up exact-match flows. This
option allows it to set up wildcarded flows, which may reduce
flow-setup latency by causing less traffic to be sent up to the
controller.
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use
ovs-controller: Add --wildcard and --normal features. This adds two command line switches to ovs-controller to: 1) Use wildcards instead of exact matches. 2) Use "normal" action instead of explicit port.
2009-11-19 12:48:32 -08:00
(because the controller does not set up flows in that case).
.
ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.IP "\fB\-N\fR"
.IQ "\fB\-\-normal\fR"
ovs-controller: Add --wildcard and --normal features. This adds two command line switches to ovs-controller to: 1) Use wildcards instead of exact matches. 2) Use "normal" action instead of explicit port.
2009-11-19 12:48:32 -08:00
By default, \fBovs\-controller\fR directs packets to a particular port
or floods them. This option causes it to direct non-flooded packets
to the OpenFlow \fBOFPP_NORMAL\fR port. This allows the switch itself
to make decisions about packet destinations. Support for
\fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well
with some non-Open vSwitch switches.
.
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
.IP "\fB\-\-mute\fR"
secchan: Better tolerate failing controller admission control in fail-open. When the switch is configured to connect to a controller that accepts connections, waits a few seconds, and then disconnects without setting up flows, currently this causes "fail-open" to flush the flow table and stop setting up new flows during the connection duration. This is OK if it happens once, but it can easily happen every 8 seconds with typical backoff settings, and that isn't so great. This commit changes fail-open to only flush the flow table once the switch appears to have been admitted by the controller, which prevents these frequent network interruptions. Thanks to Jesse Gross for especially valuable feedback. QA notes: Behavior in fail-open and especially behavior with a controller that rejects the switch after it connects needs to be re-tested. The ovs-controller --mute switch added by this commit is one simple way to create such a controller. CC: Peter Balland <peter@nicira.com> Bug #1695. Bug #2055.
2009-09-16 15:12:19 -07:00
Prevents ovs\-controller from replying to any OpenFlow messages sent
to it by switches.
.IP
This option is only for debugging the Open vSwitch implementation of
``fail open'' mode. It must not be used in production.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
ovs-controller: Add support for OpenFlow queues. Before, ovs-controller always sent packets using OFPAT_OUTPUT, which always uses the default OpenFlow queue. To help me debug the Open vSwitch QoS implementation, I want to be able to send packets on other queues, so this commit adds that feature.
2010-07-15 17:08:17 -07:00
.IP "\fB\-q \fIid\fR"
.IQ "\fB\-\-queue=\fIid\fR"
By default, \fBovs\-controller\fR uses the default OpenFlow queue for
sending packets and setting up flows. Use one of these options,
supplying \fIid\fR as an OpenFlow queue ID as a decimal number, to
instead use that specific queue.
.IP
This option may be useful for debugging quality of service setups.
.
ovs-controller: Add ability to define default flows Add support for the --with-flows option, which allows default flows to be read from a file and pushed to connecting switches.
2010-07-28 15:18:25 -07:00
.IP "\fB\-\-with\-flows \fIfile\fR"
When a switch connects, push the flow entries as described in
\fIfile\fR. Each line in \fIfile\fR is a flow entry in the format
described for the \fBadd\-flows\fR command in the \fBFlow Syntax\fR
section of the \fBovs\-ofctl\fR(8) man page.
ovs-controller: Make --with-flows read the file only once, at startup. A couple of people have reported that ovs-controller --with-flows is confusing. This seems to be because it doesn't read the file with the flows until the first connection from a switch. Then, if the file has a syntax error, it exits. This commit changes the behavior so that it reads the file immediately at startup instead.
2010-09-23 14:08:13 -07:00
.IP
Use this option more than once to add flows from multiple files.
ovs-controller: Add ability to define default flows Add support for the --with-flows option, which allows default flows to be read from a file and pushed to connecting switches.
2010-07-28 15:18:25 -07:00
.
docs: Move PKI section heading into individual manpages. The ovsdb-server manpage needs a paragraph between the heading and the first option description, so the heading can't go into the common fragment.
2010-03-18 16:59:04 -07:00
.SS "Public Key Infrastructure Options"
Factor vconn and SSL documentation into manpage include files.
2009-12-21 13:10:55 -08:00
.so lib/ssl.man
.so lib/ssl-peer-ca-cert.man
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.so lib/daemon.man
.so lib/vlog.man
ovs-controller: Add --unixctl option.
2010-03-23 11:24:38 -07:00
.so lib/unixctl.man
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.so lib/common.man
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH EXAMPLES
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.PP
ovs-controller: Document how to use with management protocol.
2010-03-24 10:42:17 -07:00
To bind locally to port 6633 (the default) and wait for incoming
connections from OpenFlow switches:
.IP
\fB% ovs\-controller ptcp:\fR
.SH "BUGS"
.PP
Configuring a Citrix XenServer to connect to a particular controller
only points the remote OVSDB management connection to that controller.
It does not also configure OpenFlow connections, because the manager
is expected to do that over the management protocol.
\fBovs\-controller\fR is not an Open vSwitch manager and does not know
how to do that.
.PP
As a stopgap workaround, \fBovs\-vsctl\fR can wait for an OVSDB
connection and set the controller, e.g.:
.IP
\fB% ovs\-vsctl \-t0 \-\-db=pssl: \-\-certificate=cert.pem
\-\-ca\-cert=none \-\-private\-key=privkey.pem
\-\-peer\-ca\-cert=cacert.pem set\-controller ssl:\fIip\fR
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.SH "SEE ALSO"
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Rename "secchan" to "ofproto" (library) and "ovs-openflowd" (program). These names are more meaningful, so we prefer them.
2009-07-08 10:30:42 -07:00
.BR ovs\-openflowd (8),
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.BR ovs\-appctl (8),
ovs-controller: Add ability to define default flows Add support for the --with-flows option, which allows default flows to be read from a file and pushed to connecting switches.
2010-07-28 15:18:25 -07:00
.BR ovs\-ofctl (8),
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.BR ovs\-dpctl (8)
Reference in New Issue Copy Permalink