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