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
  19 is retrieved.  It takes one of the following forms:
  20 .IP "\fBtcp:\fIip\fB:\fIport\fR"
  21 Connect to the given TCP \fIport\fR on \fIip\fR.
  22 .IP "\fBunix:\fIfile\fR"
  23 Connect to the Unix domain server socket named \fIfile\fR.
  24 .PP
  25 .SH OPTIONS
  26 .IP "\fB--appctl-command=\fIcommand\fR"
  27 Sets the command that \fBovs\-brcompatd\fR runs to communicate with
  28 \fBovs\-vswitchd\fR.  The command is run in \fB/bin/sh\fR as a shell
  29 command, so \fIcommand\fR may contain arbitrary shell metacharacters,
  30 etc.  The \fB--help\fR option displays the default command.
  31 .IP
  32 \fIcommand\fR must contain exactly one instance of \fB%s\fR, which
  33 \fBovs\-brcompatd\fR replaces by a command from the set understood by
  34 \fBovs\-vswitchd\fR.  Any instances of \fB%%\fR in \fIcommand\fR are
  35 replaced by a single \fB%\fR.  The \fB%\fR character may not otherwise
  36 appear in \fIcommand\fR.
  37 .IP
  38 The commands that are substituted into \fIcommand\fR are those that
  39 can be listed by passing \fBhelp\fR to \fBovs\-appctl\fR with
  40 \fBovs\-vswitchd\fR as target.
  41 .IP
  42 \fIcommand\fR must not redirect \fBovs\-appctl\fR's standard output or
  43 standard error streams, because \fBovs\-brcompatd\fR expects to read
  44 both of these streams separately.
  45 .TP
  46 \fB--prune-timeout=\fIsecs\fR
  47 .
  48 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
  49 Pruning ports is the process of removing port entries from \fIdatabase\fR
  50 that no longer exist.  If \fIsecs\fR is zero, then entries are never
  51 pruned.  The default prune timeout is 5 seconds.
  52 .
  53 .so lib/daemon.man
  54 .so lib/vlog.man
  55 .so lib/common.man
  56 .so lib/leak-checker.man
  57 .
  58 .SH NOTES
  59 \fBovs\-brcompatd\fR requires the \fBbrcompat_mod.ko\fR kernel module to be
  60 loaded.
  61 .SH "SEE ALSO"
  62 .BR ovs\-appctl (8),
  63 .BR ovs\-vswitchd (8),
  64 .BR ovsdb\-server (1),
  65 \fBINSTALL.bridge\fR in the Open vSwitch distribution.