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] \fIconfig\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.  It modifies \fIconfig\fR and forces
  16 \fBovs\-vswitchd\fR to reload its configuration file.
  17 .PP
  18 .SH OPTIONS
  19 .IP "\fB--appctl-command=\fIcommand\fR"
  20 Sets the command that \fBovs\-brcompatd\fR runs to communicate with
  21 \fBovs\-vswitchd\fR.  The command is run in \fB/bin/sh\fR as a shell
  22 command, so \fIcommand\fR may contain arbitrary shell metacharacters,
  23 etc.  The \fB--help\fR option displays the default command.
  24 .IP
  25 \fIcommand\fR must contain exactly one instance of \fB%s\fR, which
  26 \fBovs\-brcompatd\fR replaces by a command from the set understood by
  27 \fBovs\-vswitchd\fR.  Any instances of \fB%%\fR in \fIcommand\fR are
  28 replaced by a single \fB%\fR.  The \fB%\fR character may not otherwise
  29 appear in \fIcommand\fR.
  30 .IP
  31 The commands that are substituted into \fIcommand\fR are those that
  32 can be listed by passing \fB-e help\fR to \fBovs\-appctl\fR with
  33 \fBovs\-vswitchd\fR as target.  The command that is substituted may
  34 include white space-separated arguments, so \fIcommand\fR should include
  35 shell quotes around \fB%s\fR.
  36 .IP
  37 \fIcommand\fR must not redirect \fBovs\-appctl\fR's standard output or
  38 standard error streams, because \fBovs\-brcompatd\fR expects to read
  39 both of these streams separately.
  40 .TP
  41 \fB--prune-timeout=\fIsecs\fR
  42 .
  43 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
  44 Pruning ports is the process of removing port entries from \fIconfig\fR
  45 that no longer exist.  If \fIsecs\fR is zero, then entries are never
  46 pruned.  The default prune timeout is 5 seconds.
  47 .TP
  48 \fB--lock-timeout=\fImsecs\fR
  49 .
  50 Sets the maximum time to wait for \fIconfig\fR to become unlocked to
  51 \fImsecs\fR milliseconds.  The default lock timeout is 500 milliseconds.
  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 ovs\-vswitchd.conf (5),
  65 \fBINSTALL.bridge\fR in the Open vSwitch distribution.