]>
Commit | Line | Data |
---|---|---|
064af421 BP |
1 | .TH ovs\-controller 8 "March 2009" "Open vSwitch" "Open vSwitch Manual" |
2 | .ds PN ovs\-controller | |
a9b4a41a | 3 | . |
064af421 BP |
4 | .SH NAME |
5 | ovs\-controller \- simple OpenFlow controller reference implementation | |
a9b4a41a | 6 | . |
064af421 BP |
7 | .SH SYNOPSIS |
8 | .B ovs\-controller | |
9 | [\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&... | |
a9b4a41a | 10 | . |
064af421 BP |
11 | .SH DESCRIPTION |
12 | \fBovs\-controller\fR manages any number of remote switches over OpenFlow | |
13 | protocol, causing them to function as L2 MAC-learning switches or hub. | |
a9b4a41a | 14 | .PP |
064af421 BP |
15 | \fBovs\-controller\fR controls one or more OpenFlow switches, specified as |
16 | one or more of the following OpenFlow connection methods: | |
a9b4a41a | 17 | . |
84ee7bcf BP |
18 | .RS |
19 | .so lib/vconn-passive.man | |
20 | .so lib/vconn-active.man | |
21 | .RE | |
a9b4a41a | 22 | . |
064af421 | 23 | .SH OPTIONS |
064af421 BP |
24 | .IP "\fB-n\fR, \fB--noflow\fR" |
25 | By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch | |
26 | whenever it receives a packet whose destination is known due through | |
27 | MAC learning. This option disables flow setup, so that every packet | |
28 | in the network passes through the controller. | |
a9b4a41a | 29 | .IP |
064af421 BP |
30 | This option is most useful for debugging. It reduces switching |
31 | performance, so it should not be used in production. | |
a9b4a41a | 32 | . |
064af421 BP |
33 | .TP |
34 | \fB--max-idle=\fIsecs\fR|\fBpermanent\fR | |
35 | Sets \fIsecs\fR as the number of seconds that a flow set up by the | |
36 | controller will remain in the switch's flow table without any matching | |
37 | packets being seen. If \fBpermanent\fR is specified, which is not | |
38 | recommended, flows will never expire. The default is 60 seconds. | |
a9b4a41a | 39 | .IP |
064af421 BP |
40 | This option affects only flows set up by the OpenFlow controller. In |
41 | some configurations, the switch can set up some flows | |
42 | on its own. To set the idle time for those flows, pass | |
8cd4882f | 43 | \fB--max-idle\fR to \fBovs\-openflowd\fR (on the switch). |
a9b4a41a | 44 | .IP |
064af421 BP |
45 | This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use |
46 | (because the controller does not set up flows in that case). | |
a9b4a41a | 47 | . |
064af421 BP |
48 | .IP "\fB-H\fR, \fB--hub\fR" |
49 | By default, the controller acts as an L2 MAC-learning switch. This | |
50 | option changes its behavior to that of a hub that floods packets on | |
51 | all but the incoming port. | |
a9b4a41a | 52 | .IP |
064af421 BP |
53 | If \fB-H\fR (or \fB--hub\fR) and \fB-n\fR (or \fB--noflow\fR) are used |
54 | together, then the cumulative effect is that every packet passes | |
55 | through the controller and every packet is flooded. | |
a9b4a41a | 56 | .IP |
064af421 BP |
57 | This option is most useful for debugging. It reduces switching |
58 | performance, so it should not be used in production. | |
9af9e2e8 JT |
59 | . |
60 | .IP "\fB-w\fR, \fB--wildcard\fR" | |
61 | By default, \fBovs\-controller\fR sets up exact-match flows. This | |
62 | option allows it to set up wildcarded flows, which may reduce | |
63 | flow-setup latency by causing less traffic to be sent up to the | |
64 | controller. | |
65 | .IP | |
66 | This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use | |
67 | (because the controller does not set up flows in that case). | |
68 | . | |
69 | .IP "\fB-N\fR, \fB--normal\fR" | |
70 | By default, \fBovs\-controller\fR directs packets to a particular port | |
71 | or floods them. This option causes it to direct non-flooded packets | |
72 | to the OpenFlow \fBOFPP_NORMAL\fR port. This allows the switch itself | |
73 | to make decisions about packet destinations. Support for | |
74 | \fBOFPP_NORMAL\fR is optional in OpenFlow, so this option may not well | |
75 | with some non-Open vSwitch switches. | |
76 | . | |
7778bd15 BP |
77 | .IP "\fB--mute\fR" |
78 | Prevents ovs\-controller from replying to any OpenFlow messages sent | |
79 | to it by switches. | |
80 | .IP | |
81 | This option is only for debugging the Open vSwitch implementation of | |
82 | ``fail open'' mode. It must not be used in production. | |
a9b4a41a | 83 | . |
ac300505 | 84 | .SS "Public Key Infrastructure Options" |
84ee7bcf BP |
85 | .so lib/ssl.man |
86 | .so lib/ssl-peer-ca-cert.man | |
064af421 BP |
87 | .so lib/daemon.man |
88 | .so lib/vlog.man | |
b66bdf30 | 89 | .so lib/unixctl.man |
064af421 | 90 | .so lib/common.man |
a9b4a41a | 91 | . |
064af421 | 92 | .SH EXAMPLES |
a9b4a41a | 93 | . |
064af421 BP |
94 | .TP |
95 | To bind locally to port 6633 (the default) and wait for incoming connections from OpenFlow switches: | |
a9b4a41a | 96 | .PP |
064af421 | 97 | .B % ovs\-controller ptcp: |
a9b4a41a | 98 | . |
064af421 | 99 | .SH "SEE ALSO" |
a9b4a41a | 100 | . |
8cd4882f | 101 | .BR ovs\-openflowd (8), |
064af421 BP |
102 | .BR ovs\-appctl (8), |
103 | .BR ovs\-dpctl (8) |