bridge: Monitor fewer OVSDB columns.
[sliver-openvswitch.git] / vswitchd / ovs-brcompatd.8.in
1 .TH ovs\-brcompatd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
2 .ds PN ovs\-brcompatd
3 .
4 .SH NAME
5 ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd
6 .
7 .SH SYNOPSIS
8 .B ovs\-brcompatd
9 [\fIoptions\fR] \fIdatabase\fR
10 .
11 .SH DESCRIPTION
12 A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It
13 does this by listening for bridge ioctl commands (e.g., those generated by
14 the \fBbrctl\fR program) to add or remove datapaths and the interfaces
15 that attach to them.
16 .PP
17 The mandatory \fIdatabase\fR argument specifies the
18 \fBovsdb\-server\fR from which \fBovs\-vswitchd\fR's configuration is
19 retrieved.  It should take the form \fBunix:\fIfile\fR, to connect to
20 the Unix domain server socket named \fIfile\fR.
21 .PP
22 .SH OPTIONS
23 .IP "\fB\-\-appctl\-command=\fIcommand\fR"
24 Sets the command that \fBovs\-brcompatd\fR runs to communicate with
25 \fBovs\-vswitchd\fR.  The command is run in \fB/bin/sh\fR as a shell
26 command, so \fIcommand\fR may contain arbitrary shell metacharacters,
27 etc.  The \fB\-\-help\fR option displays the default command.
28 .IP
29 \fIcommand\fR must contain exactly one instance of \fB%s\fR, which
30 \fBovs\-brcompatd\fR replaces by a command from the set understood by
31 \fBovs\-vswitchd\fR.  Any instances of \fB%%\fR in \fIcommand\fR are
32 replaced by a single \fB%\fR.  The \fB%\fR character may not otherwise
33 appear in \fIcommand\fR.
34 .IP
35 The commands that are substituted into \fIcommand\fR are those that
36 can be listed by passing \fBhelp\fR to \fBovs\-appctl\fR with
37 \fBovs\-vswitchd\fR as target.
38 .IP
39 \fIcommand\fR must not redirect \fBovs\-appctl\fR's standard output or
40 standard error streams, because \fBovs\-brcompatd\fR expects to read
41 both of these streams separately.
42 .TP
43 \fB\-\-prune\-timeout=\fIsecs\fR
44 .
45 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
46 Pruning ports is the process of removing port entries from \fIdatabase\fR
47 that no longer exist.  If \fIsecs\fR is zero, then entries are never
48 pruned.  The default prune timeout is 5 seconds.
49 .
50 .so lib/daemon.man
51 .so lib/vlog.man
52 .so lib/common.man
53 .so lib/leak-checker.man
54 .
55 .SH NOTES
56 \fBovs\-brcompatd\fR requires the \fBbrcompat_mod.ko\fR kernel module to be
57 loaded.
58 .SH "SEE ALSO"
59 .BR ovs\-appctl (8),
60 .BR ovs\-vswitchd (8),
61 .BR ovsdb\-server (1),
62 \fBINSTALL.bridge\fR in the Open vSwitch distribution.