ovsdb/ovsdb-server.1.in

   1 .\" -*- nroff -*-
   2 .TH ovsdb\-server 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
   3 .ds PN ovsdb\-server
   4 .
   5 .SH NAME
   6 ovsdb\-server \- Open vSwitch database server
   7 .
   8 .SH SYNOPSIS
   9 \fBovsdb\-server\fR
  10 \fIdatabase\fR
  11 [\fB--remote=\fIremote\fR]\&...
  12 [\fB--run=\fIcommand\fR]
  13 .so lib/daemon-syn.man
  14 .so lib/vlog-syn.man
  15 .so lib/common-syn.man
  16 .
  17 .SH DESCRIPTION
  18 The \fBovsdb\-server\fR program provides RPC interfaces to an Open
  19 vSwitch database (OVSDB).  It supports JSON-RPC client connections
  20 over active or passive TCP/IP or Unix domain sockets.
  21 .PP
  22 The name of the OVSDB file must be specified on the command line as
  23 \fIdatabase\fR, which must already have been created and initialized
  24 using, for example, \fBovsdb\-tool create\fR.
  25 .
  26 .SH OPTIONS
  27 .
  28 .IP "\fB\-\-remote=\fIremote\fR"
  29 Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
  30 \fIremote\fR must take one of the following forms:
  31 .
  32 .RS
  33 .so ovsdb/remote-passive.man
  34 .so ovsdb/remote-active.man
  35 .
  36 .IP "\fBdb:\fItable\fB,\fIcolumn\fR"
  37 Reads additional connection methods from \fIcolumn\fR in all of the
  38 rows in \fItable\fR within the \fBovsdb\-server\fR database.  The
  39 \fIcolumn\fR must have type string or set of strings.  The connection
  40 methods in the column must have one of the forms described above.  As
  41 the contents of \fIcolumn\fR changes, \fBovsdb\-server\fR also adds
  42 and drops connection methods accordingly.
  43 .RE
  44 .
  45 .IP "\fB\-\-run=\fIcommand\fR]"
  46 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
  47 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
  48 \fBovsdb\-server\fR instead starts a shell subprocess running
  49 \fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
  50 also exits gracefully.  If the subprocess exits normally with exit
  51 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
  52 otherwise, it exits with exit code 1.
  53 .IP
  54 This option can be useful where a database server is needed only to
  55 run a single command, e.g.:
  56 .B "ovsdb-server --remote=punix:socket --run='ovsdb-client dump unix:socket Open_vSwitch'"
  57 .SS "Daemon Options"
  58 .so lib/daemon.man
  59 .SS "Logging Options"
  60 .so lib/vlog.man
  61 .SS "Public Key Infrastructure Options"
  62 The options described below for configuring the SSL public key
  63 infrastructure accept a special syntax for obtaining their
  64 configuration from the database.  If any of these options is given
  65 \fBdb:\fItable\fB,\fIcolumn\fR as its argument, then the actual file
  66 name is read from the specified \fIcolumn\fR in \fItable\fR within the
  67 \fBovsdb\-server\fR database.  The \fIcolumn\fR must have type string
  68 or set of strings.  The first nonempty string in the table is taken as
  69 the file name.  (This means that ordinarily there should be at most
  70 one row in \fItable\fR.)
  71 .so lib/ssl.man
  72 .so lib/ssl-bootstrap.man
  73 .SS "Other Options"
  74 .so lib/common.man
  75 .SH "RUNTIME MANAGEMENT COMMANDS"
  76 \fBovs\-appctl\fR(8) can send commands to a running
  77 \fBovsdb\-server\fR process.  The currently supported commands are
  78 described below.
  79 .SS "OVSDB-SERVER COMMANDS"
  80 These commands are specific to \fBovsdb\-server\fR.
  81 .IP "\fBexit\fR"
  82 Causes \fBovsdb\-server\fR to gracefully terminate.
  83 .IP "\fBovsdb-server/compact\fR"
  84 Compacts the database in-place.  The database is also automatically
  85 compacted occasionally.
  86 .so lib/vlog-unixctl.man
  87 .SH "SEE ALSO"
  88 .
  89 .BR ovsdb\-tool (1).