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 .RE
  36 .
  37 .IP "\fB\-\-run=\fIcommand\fR]"
  38 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
  39 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
  40 \fBovsdb\-server\fR instead starts a shell subprocess running
  41 \fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
  42 also exits gracefully.  If the subprocess exits normally with exit
  43 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
  44 otherwise, it exits with exit code 1.
  45 .IP
  46 This option can be useful where a database server is needed only to
  47 run a single command, e.g.:
  48 .B "ovsdb-server --remote=punix:socket --run='ovsdb-client dump unix:socket Open_vSwitch'"
  49 .SS "Daemon Options"
  50 .so lib/daemon.man
  51 .SS "Logging Options"
  52 .so lib/vlog.man
  53 .SS "Public Key Infrastructure Options"
  54 .so lib/ssl.man
  55 .SS "Other Options"
  56 .so lib/common.man
  57 .SH "RUNTIME MANAGEMENT COMMANDS"
  58 \fBovs\-appctl\fR(8) can send commands to a running
  59 \fBovsdb\-server\fR process.  The currently supported commands are
  60 described below.
  61 .SS "OVSDB-SERVER COMMANDS"
  62 These commands are specific to \fBovsdb\-server\fR.
  63 .IP "\fBexit\fR"
  64 Causes \fBovsdb\-server\fR to gracefully terminate.
  65 .IP "\fBovsdb-server/compact\fR"
  66 Compacts the database in-place.  The database is also automatically
  67 compacted occasionally.
  68 .so lib/vlog-unixctl.man
  69 .SH "SEE ALSO"
  70 .
  71 .BR ovsdb\-tool (1).