xenserver: Add support for disabling in-band management via XAPI.
[openvswitch] / vswitchd / ovs-vswitchd.8.in
1 .\" -*- nroff -*-
2 .de IQ
3 .  br
4 .  ns
5 .  IP "\\$1"
6 ..
7 .TH ovs\-vswitchd 8 "June 2009" "Open vSwitch" "Open vSwitch Manual"
8 .\" This program's name:
9 .ds PN ovs\-vswitchd
10 .\" SSL peer program's name:
11 .ds SN ovs\-controller
12 .
13 .SH NAME
14 ovs\-vswitchd \- Open vSwitch daemon
15 .
16 .SH SYNOPSIS
17 .B ovs\-vswitchd
18 \fIdatabase\fR
19 .
20 .SH DESCRIPTION
21 A daemon that manages and controls any number of Open vSwitch switches
22 on the local machine.
23 .PP
24 The mandatory \fIdatabase\fR argument normally takes the form
25 \fBunix:\fIfile\fR, where \fIfile\fR is the name of a Unix domain
26 socket on which \fBovsdb\-server\fR is listening.  However, all of the
27 following forms are accepted:
28 .so ovsdb/remote-active.man
29 .so ovsdb/remote-passive.man
30 .PP
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.
39 .PP
40 \fBovs\-vswitchd\fR switches may be configured with any of the following
41 features:
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
60 sFlow(R) monitoring.
61 .
62 .IP \(bu
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.
67 A single \fBovs\-vswitchd\fR can manage any number of switch instances, up
68 to the maximum number of supported Open vSwitch datapaths.
69 .PP
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
73 \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths
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
80 to be useful.  Please refer to the \fBINSTALL.Linux\fR file included in the
81 Open vSwitch distribution for instructions on how to build and load
82 the Open vSwitch kernel module.
83 .PP
84 .SH OPTIONS
85 .IP "\fB\-\-mlockall\fR"
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 .
96 .ds DD \
97 \fBovs\-vswitchd\fR detaches only after it has connected to the \
98 database, retrieved the initial configuration, and set up that \
99 configuration.
100 .so lib/daemon.man
101 .SS "Public Key Infrastructure Options"
102 .so lib/ssl.man
103 .so lib/ssl-bootstrap.man
104 .so lib/vlog.man
105 .so lib/common.man
106 .so lib/leak-checker.man
107 .
108 .SH "RUNTIME MANAGEMENT COMMANDS"
109 \fBovs\-appctl\fR(8) can send commands to a running
110 \fBovs\-vswitchd\fR process.  The currently supported commands are
111 described below.  The command descriptions assume an understanding of
112 how to configure Open vSwitch.
113 .SS "GENERAL COMMANDS"
114 .IP "\fBexit\fR"
115 Causes \fBovs\-vswitchd\fR to gracefully terminate.
116 .SS "BRIDGE COMMANDS"
117 These commands manage bridges.
118 .IP "\fBfdb/show\fR \fIbridge\fR"
119 Lists each MAC address/VLAN pair learned by the specified \fIbridge\fR,
120 along with the port on which it was learned and the age of the entry,
121 in seconds.
122 .IP "\fBbridge/reconnect\fR [\fIbridge\fR]"
123 Makes \fIbridge\fR drop all of its OpenFlow controller connections and
124 reconnect.  If \fIbridge\fR is not specified, then all bridges drop
125 their controller connections and reconnect.
126 .IP
127 This command might be useful for debugging OpenFlow controller issues.
128 .
129 .IP "\fBbridge/dump\-flows\fR \fIbridge\fR"
130 Lists all flows in \fIbridge\fR, including those normally hidden to
131 commands such as \fBovs\-ofctl dump\-flows\fR.  Flows set up by mechanisms
132 such as in-band control and fail-open are hidden from the controller
133 since it is not allowed to modify or override them.
134 .SS "BOND COMMANDS"
135 These commands manage bonded ports on an Open vSwitch's bridges.  To
136 understand some of these commands, it is important to understand a
137 detail of the bonding implementation called ``source load balancing''
138 (SLB).  Instead of directly assigning Ethernet source addresses to
139 slaves, the bonding implementation computes a function that maps an
140 48-bit Ethernet source addresses into an 8-bit value (a ``MAC hash''
141 value).  All of the Ethernet addresses that map to a single 8-bit
142 value are then assigned to a single slave.
143 .IP "\fBbond/list\fR"
144 Lists all of the bonds, and their slaves, on each bridge.
145 .
146 .IP "\fBbond/show\fR \fIport\fR"
147 Lists all of the bond-specific information about the given bonded
148 \fIport\fR: updelay, downdelay, time until the next rebalance.  Also
149 lists information about each slave: whether it is enabled or disabled,
150 the time to completion of an updelay or downdelay if one is in
151 progress, whether it is the active slave, the MAC hashes assigned to
152 the slave, and the MAC learning table entries that hash to each MAC.
153 .IP "\fBbond/migrate\fR \fIport\fR \fIhash\fR \fIslave\fR"
154 Only valid for SLB bonds.  Assigns a given MAC hash to a new slave.
155 \fIport\fR specifies the bond port, \fIhash\fR the MAC hash to be
156 migrated (as a decimal number between 0 and 255), and \fIslave\fR the
157 new slave to be assigned.
158 .IP
159 The reassignment is not permanent: rebalancing or fail-over will
160 cause the MAC hash to be shifted to a new slave in the usual
161 manner.
162 .IP
163 A MAC hash cannot be migrated to a disabled slave.
164 .IP "\fBbond/set\-active\-slave\fR \fIport\fR \fIslave\fR"
165 Sets \fIslave\fR as the active slave on \fIport\fR.  \fIslave\fR must
166 currently be enabled.
167 .IP
168 The setting is not permanent: a new active slave will be selected
169 if \fIslave\fR becomes disabled.
170 .IP "\fBbond/enable\-slave\fR \fIport\fR \fIslave\fR"
171 .IQ "\fBbond/disable\-slave\fR \fIport\fR \fIslave\fR"
172 Enables (or disables) \fIslave\fR on the given bond \fIport\fR, skipping any
173 updelay (or downdelay).
174 .IP
175 This setting is not permanent: it persists only until the carrier
176 status of \fIslave\fR changes.
177 .IP "\fBbond/hash\fR \fImac\fR [\fIvlan\fR]"
178 Returns the hash value which would be used for \fImac\fR with \fIvlan\fR
179 if specified.
180 .
181 .so ofproto/ofproto-unixctl.man
182 .so lib/vlog-unixctl.man
183 .so lib/stress-unixctl.man
184 .SH "SEE ALSO"
185 .BR ovs\-appctl (8),
186 .BR ovs\-brcompatd (8),
187 .BR ovsdb\-server (1),
188 \fBINSTALL.Linux\fR in the Open vSwitch distribution.