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