summaryrefslogtreecommitdiff
path: root/vswitchd/ovs-vswitchd.8.in
blob: 28e55ba31ca4365dc2d40c5a0d5b7873f5163200 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
.TH ovs\-vswitchd 8 "March 2009" "Open vSwitch" "OpenVSwitch Manual"
.ds PN ovs\-vswitchd
.
.SH NAME
ovs\-vswitchd \- virtual switch daemon
.
.SH SYNOPSIS
.B ovs\-vswitchd
\fIconfig\fR
.
.SH DESCRIPTION
A daemon that manages and controls any number of virtual switches on
the local machine.
.PP
The mandatory \fIconfig\fR argument specifies a configuration file.
For a description of \fBovs\-vswitchd\fR configuration syntax, see
\fBovs\-vswitchd.conf\fR(5).
.PP
At startup or upon receipt of a \fBSIGHUP\fR signal, \fBovs\-vswitchd\fR
reads the configuration file.  It sets up Open vSwitch datapaths and then 
operates switching across each bridge described in its configuration 
files.  If a logfile was specified on the command line it will also 
be opened or reopened.
.PP
\fBovs\-vswitchd\fR virtual switches may be configured with any of the
following features:
.
.IP \(bu
L2 switching with MAC learning.
.
.IP \(bu
NIC bonding with automatic fail-over and source MAC-based TX load
balancing ("SLB").
.
.IP \(bu
802.1Q VLAN support.
.
.IP \(bu
Port mirroring, with optional VLAN tagging.
.
.IP \(bu
NetFlow v5 flow logging.
.
.IP \(bu
Connectivity to an external OpenFlow controller, such as NOX.
.
.PP
Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time.
A single \fBovs\-vswitchd\fR can manage any number of virtual switches, up
to the maximum number of supported Open vSwitch datapaths.
.PP
\fBovs\-vswitchd\fR does all the necessary management of OpenVSwitch datapaths
itself.  Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for
managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use
to modify datapaths when \fBovs\-vswitchd\fR is running can interfere with
its operation.  (\fBovs\-dpctl\fR may still be useful for diagnostics.)
.PP
An Open vSwitch datapath kernel module must be loaded for \fBovs\-vswitchd\fR
to be useful.  Please refer to the \fBINSTALL\fR file included in the
Open vSwitch distribution for instructions on how to build and load
the Open vSwitch kernel module.
.PP
.SH OPTIONS
.IP "\fB--fake-proc-net\fR"
Causes \fBovs\-vswitchd\fR to simulate some files in \fB/proc/net/vlan\fR
and \fB/proc/net/bonding\fR that some legacy software expects to
exist.  This option should only be used if such legacy software is
actually in use.  It requires the \fBbrcompat_mod.ko\fR kernel module
to be loaded.
.
.so lib/daemon.man
.so lib/vlog.man
.so lib/common.man
.so lib/leak-checker.man
.
.SH "BUGS"
.
Only Open vSwitch kernel-based datapaths are currently supported.  In the
future, this restriction may be lifted.
.PP
Only Linux 2.6.\fIx\fR is currently supported.
.
.SH "SEE ALSO"
.BR ovs\-appctl (8),
.BR ovs\-vswitchd.conf (5),
.BR ovs\-brcompatd (8),
\fBINSTALL\fR in the Open vSwitch distribution.