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