ovsdb/ovsdb-server.1.in

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