]>
Commit | Line | Data |
---|---|---|
7d9809ef BP |
1 | .\" -*- nroff -*- |
2 | .de IQ | |
3 | . br | |
4 | . ns | |
5 | . IP "\\$1" | |
6 | .. | |
f30f26be | 7 | .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual" |
812560d7 | 8 | .\" This program's name: |
064af421 | 9 | .ds PN ovs\-vswitchd |
812560d7 BP |
10 | .\" SSL peer program's name: |
11 | .ds SN ovs\-controller | |
064af421 BP |
12 | . |
13 | .SH NAME | |
f30f26be | 14 | ovs\-vswitchd \- Open vSwitch daemon |
064af421 BP |
15 | . |
16 | .SH SYNOPSIS | |
17 | .B ovs\-vswitchd | |
76343538 | 18 | \fIdatabase\fR |
064af421 BP |
19 | . |
20 | .SH DESCRIPTION | |
299a244b | 21 | A daemon that manages and controls any number of Open vSwitch switches |
f30f26be | 22 | on the local machine. |
064af421 | 23 | .PP |
cb8141b2 BP |
24 | The mandatory \fIdatabase\fR argument normally takes the form |
25 | \fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain | |
4e312e69 | 26 | socket on which \fBovsdb\-server\fR is listening. However, all of the |
cb8141b2 | 27 | following forms are accepted: |
6f61c75b | 28 | .so ovsdb/remote-active.man |
c9f3f37a | 29 | .so ovsdb/remote-passive.man |
064af421 | 30 | .PP |
76343538 BP |
31 | \fBovs\-vswitchd\fR retrieves its configuration from \fIdatabase\fR at |
32 | startup. It sets up Open vSwitch datapaths and then operates | |
33 | switching across each bridge described in its configuration files. As | |
34 | the database changes, \fBovs\-vswitchd\fR automatically updates its | |
35 | configuration to match. | |
36 | .PP | |
37 | Upon receipt of a SIGHUP signal, \fBovs\-vswitchd\fR reopens its log | |
38 | file, if one was specified on the command line. | |
064af421 | 39 | .PP |
299a244b | 40 | \fBovs\-vswitchd\fR switches may be configured with any of the following |
f30f26be | 41 | features: |
064af421 BP |
42 | . |
43 | .IP \(bu | |
44 | L2 switching with MAC learning. | |
45 | . | |
46 | .IP \(bu | |
47 | NIC bonding with automatic fail-over and source MAC-based TX load | |
48 | balancing ("SLB"). | |
49 | . | |
50 | .IP \(bu | |
51 | 802.1Q VLAN support. | |
52 | . | |
53 | .IP \(bu | |
54 | Port mirroring, with optional VLAN tagging. | |
55 | . | |
56 | .IP \(bu | |
57 | NetFlow v5 flow logging. | |
58 | . | |
59 | .IP \(bu | |
d1ae8299 | 60 | sFlow(R) monitoring. |
72b06300 BP |
61 | . |
62 | .IP \(bu | |
064af421 BP |
63 | Connectivity to an external OpenFlow controller, such as NOX. |
64 | . | |
65 | .PP | |
66 | Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time. | |
f30f26be | 67 | A single \fBovs\-vswitchd\fR can manage any number of switch instances, up |
064af421 BP |
68 | to the maximum number of supported Open vSwitch datapaths. |
69 | .PP | |
cb49ee4f BP |
70 | \fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR, |
71 | and more. Do not run both daemons at the same time. | |
72 | .PP | |
f30f26be | 73 | \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths |
064af421 BP |
74 | itself. Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for |
75 | managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use | |
76 | to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with | |
77 | its operation. (\fBovs\-dpctl\fR may still be useful for diagnostics.) | |
78 | .PP | |
79 | An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR | |
5fca1acd | 80 | to be useful. Please refer to the \fBINSTALL.Linux\fR file included in the |
064af421 BP |
81 | Open vSwitch distribution for instructions on how to build and load |
82 | the Open vSwitch kernel module. | |
83 | .PP | |
84 | .SH OPTIONS | |
4e312e69 | 85 | .IP "\fB\-\-mlockall\fR" |
86a06318 BP |
86 | Causes \fBovs\-vswitchd\fR to call the \fBmlockall()\fR function, to |
87 | attempt to lock all of its process memory into physical RAM, | |
88 | preventing the kernel from paging any of its memory to disk. This | |
89 | helps to avoid networking interruptions due to system memory pressure. | |
90 | .IP | |
91 | Some systems do not support \fBmlockall()\fR at all, and other systems | |
92 | only allow privileged users, such as the superuser, to use it. | |
93 | \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is | |
94 | unavailable or unsuccessful. | |
95 | . | |
4e312e69 | 96 | .IP "\fB\-\-fake\-proc\-net\fR" |
064af421 BP |
97 | Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR |
98 | and \fB/proc/net/bonding\fR that some legacy software expects to | |
99 | exist. This option should only be used if such legacy software is | |
100 | actually in use. It requires the \fBbrcompat_mod.ko\fR kernel module | |
101 | to be loaded. | |
bfb1f2d5 BP |
102 | .IP |
103 | On non-Linux hosts, this option is accepted but has no effect. | |
064af421 BP |
104 | . |
105 | .so lib/daemon.man | |
ac300505 | 106 | .SS "Public Key Infrastructure Options" |
6f61c75b BP |
107 | .so lib/ssl.man |
108 | .so lib/ssl-bootstrap.man | |
064af421 BP |
109 | .so lib/vlog.man |
110 | .so lib/common.man | |
111 | .so lib/leak-checker.man | |
112 | . | |
b16fdafe BP |
113 | .SH "RUNTIME MANAGEMENT COMMANDS" |
114 | \fBovs\-appctl\fR(8) can send commands to a running | |
115 | \fBovs\-vswitchd\fR process. The currently supported commands are | |
116 | described below. The command descriptions assume an understanding of | |
76343538 | 117 | how to configure Open vSwitch. |
9e15c889 BP |
118 | .SS "GENERAL COMMANDS" |
119 | .IP "\fBexit\fR" | |
120 | Causes \fBovs\-vswitchd\fR to gracefully terminate. | |
b16fdafe BP |
121 | .SS "BRIDGE COMMANDS" |
122 | These commands manage bridges. | |
123 | .IP "\fBfdb/show\fR \fIbridge\fR" | |
124 | Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR, | |
125 | along with the port on which it was learned and the age of the entry, | |
126 | in seconds. | |
fa05809b BP |
127 | .IP "\fBbridge/reconnect\fR [\fIbridge\fR]" |
128 | Makes \fIbridge\fR drop all of its OpenFlow controller connections and | |
129 | reconnect. If \fIbridge\fR is not specified, then all bridges drop | |
130 | their controller connections and reconnect. | |
131 | .IP | |
132 | This command might be useful for debugging OpenFlow controller issues. | |
cdd35cff | 133 | . |
4e312e69 | 134 | .IP "\fBbridge/dump\-flows\fR \fIbridge\fR" |
cdd35cff | 135 | Lists all flows in \fIbridge\fR, including those normally hidden to |
4e312e69 | 136 | commands such as \fBovs\-ofctl dump\-flows\fR. Flows set up by mechanisms |
cdd35cff JP |
137 | such as in-band control and fail-open are hidden from the controller |
138 | since it is not allowed to modify or override them. | |
b16fdafe BP |
139 | .SS "BOND COMMANDS" |
140 | These commands manage bonded ports on an Open vSwitch's bridges. To | |
141 | understand some of these commands, it is important to understand a | |
142 | detail of the bonding implementation called ``MAC hashing.'' Instead | |
143 | of directly assigning Ethernet source addresses to slaves, the bonding | |
144 | implementation computes a function that maps an 48-bit Ethernet source | |
145 | addresses into an 8-bit value (a ``MAC hash'' value). All of the | |
146 | Ethernet addresses that map to a single 8-bit value are then assigned | |
147 | to a single slave. | |
148 | .IP "\fBbond/list\fR" | |
149 | Lists all of the bonds, and their slaves, on each bridge. | |
064af421 | 150 | . |
b16fdafe BP |
151 | .IP "\fBbond/show\fR \fIport\fR" |
152 | Lists all of the bond-specific information about the given bonded | |
153 | \fIport\fR: updelay, downdelay, time until the next rebalance. Also | |
154 | lists information about each slave: whether it is enabled or disabled, | |
155 | the time to completion of an updelay or downdelay if one is in | |
156 | progress, whether it is the active slave, the MAC hashes assigned to | |
157 | the slave, and the MAC learning table entries that hash to each MAC. | |
158 | .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR" | |
159 | Assigns a given MAC hash to a new slave. \fIport\fR specifies the | |
557c178b EJ |
160 | bond port, \fIhash\fR the MAC hash to be migrated (as a decimal |
161 | number between 0 and 255), and \fIslave\fR the new slave to be | |
162 | assigned. | |
b16fdafe BP |
163 | .IP |
164 | The reassignment is not permanent: rebalancing or fail-over will | |
165 | cause the MAC hash to be shifted to a new slave in the usual | |
166 | manner. | |
167 | .IP | |
168 | A MAC hash cannot be migrated to a disabled slave. | |
4e312e69 | 169 | .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR" |
b16fdafe BP |
170 | Sets \fIslave\fR as the active slave on \fIport\fR. \fIslave\fR must |
171 | currently be enabled. | |
172 | .IP | |
173 | The setting is not permanent: a new active slave will be selected | |
174 | if \fIslave\fR becomes disabled. | |
4e312e69 BP |
175 | .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR" |
176 | .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR" | |
b16fdafe BP |
177 | Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any |
178 | updelay (or downdelay). | |
179 | .IP | |
180 | This setting is not permanent: it persists only until the carrier | |
181 | status of \fIslave\fR changes. | |
e58de0e3 EJ |
182 | .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR]" |
183 | Returns the hash value which would be used for \fImac\fR with \fIvlan\fR | |
184 | if specified. | |
064af421 | 185 | . |
7aa697dd | 186 | .so ofproto/ofproto-unixctl.man |
b16fdafe | 187 | .so lib/vlog-unixctl.man |
cc01d0bb | 188 | .so lib/stress-unixctl.man |
064af421 BP |
189 | .SH "SEE ALSO" |
190 | .BR ovs\-appctl (8), | |
064af421 | 191 | .BR ovs\-brcompatd (8), |
76343538 | 192 | .BR ovsdb\-server (1), |
5fca1acd | 193 | \fBINSTALL.Linux\fR in the Open vSwitch distribution. |