ovsdb/ovsdb-server.1.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovsdb\-server 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
   8 .\" This program's name:
   9 .ds PN ovsdb\-server
  10 .
  11 .SH NAME
  12 ovsdb\-server \- Open vSwitch database server
  13 .
  14 .SH SYNOPSIS
  15 \fBovsdb\-server\fR
  16 [\fIdatabase\fR]\&...
  17 [\fB\-\-remote=\fIremote\fR]\&...
  18 [\fB\-\-run=\fIcommand\fR]
  19 .so lib/daemon-syn.man
  20 .so lib/vlog-syn.man
  21 .so lib/ssl-syn.man
  22 .so lib/ssl-bootstrap-syn.man
  23 .so lib/unixctl-syn.man
  24 .so lib/common-syn.man
  25 .
  26 .SH DESCRIPTION
  27 The \fBovsdb\-server\fR program provides RPC interfaces to one or more
  28 Open vSwitch databases (OVSDBs).  It supports JSON-RPC client
  29 connections over active or passive TCP/IP or Unix domain sockets.
  30 .PP
  31 Each OVSDB file may be specified on the command line as \fIdatabase\fR.
  32 If none is specified, the default is \fB@DBDIR@/conf.db\fR.  The database
  33 files must already have been created and initialized using, for
  34 example, \fBovsdb\-tool create\fR.
  35 .
  36 .SH OPTIONS
  37 .
  38 .IP "\fB\-\-remote=\fIremote\fR"
  39 Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
  40 \fIremote\fR must take one of the following forms:
  41 .
  42 .RS
  43 .so ovsdb/remote-passive.man
  44 .so ovsdb/remote-active.man
  45 .
  46 .IP "\fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR"
  47 Reads additional connection methods from \fIcolumn\fR in all of the
  48 rows in \fItable\fR within \fIdb\fR.  As the contents of \fIcolumn\fR changes,
  49 \fBovsdb\-server\fR also adds and drops connection methods accordingly.
  50 .IP
  51 If \fIcolumn\fR's type is string or set of strings, then the
  52 connection methods are taken directly from the column.  The connection
  53 methods in the column must have one of the forms described above.
  54 .IP
  55 If \fIcolumn\fR's type is UUID or set of UUIDs and references a table,
  56 then each UUID is looked up in the referenced table to obtain a row.
  57 The following columns in the row, if present and of the correct type,
  58 configure a connection method.  Any additional columns are ignored.
  59 .RS
  60 .IP "\fBtarget\fR (string)"
  61 Connection method, in one of the forms described above.  This column
  62 is mandatory: if it is missing or empty then no connection method can
  63 be configured.
  64 .IP "\fBmax_backoff\fR (integer)"
  65 Maximum number of milliseconds to wait between connection attempts.
  66 .IP "\fBinactivity_probe\fR (integer)"
  67 Maximum number of milliseconds of idle time on connection to
  68 client before sending an inactivity probe message.
  69 .RE
  70 .IP
  71 It is an error for \fIcolumn\fR to have another type.
  72 .RE
  73 .
  74 .IP
  75 To connect or listen on multiple connection methods, use multiple
  76 \fB\-\-remote\fR options.
  77 .
  78 .IP "\fB\-\-run=\fIcommand\fR]"
  79 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
  80 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
  81 \fBovsdb\-server\fR instead starts a shell subprocess running
  82 \fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
  83 also exits gracefully.  If the subprocess exits normally with exit
  84 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
  85 otherwise, it exits with exit code 1.
  86 .IP
  87 This option can be useful where a database server is needed only to
  88 run a single command, e.g.:
  89 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
  90 .SS "Daemon Options"
  91 .ds DD \
  92 \fBovsdb\-server\fR detaches only after it starts listening on all \
  93 configured remotes.
  94 .so lib/daemon.man
  95 .SS "Logging Options"
  96 .so lib/vlog.man
  97 .SS "Public Key Infrastructure Options"
  98 The options described below for configuring the SSL public key
  99 infrastructure accept a special syntax for obtaining their
 100 configuration from the database.  If any of these options is given
 101 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR as its argument, then the
 102 actual file name is read from the specified \fIcolumn\fR in \fItable\fR
 103 within the \fIdb\fR database.  The \fIcolumn\fR must have type
 104 string or set of strings.  The first nonempty string in the table is taken
 105 as the file name.  (This means that ordinarily there should be at most
 106 one row in \fItable\fR.)
 107 .so lib/ssl.man
 108 .so lib/ssl-bootstrap.man
 109 .SS "Other Options"
 110 .so lib/unixctl.man
 111 .so lib/common.man
 112 .SH "RUNTIME MANAGEMENT COMMANDS"
 113 \fBovs\-appctl\fR(8) can send commands to a running
 114 \fBovsdb\-server\fR process.  The currently supported commands are
 115 described below.
 116 .SS "OVSDB\-SERVER COMMANDS"
 117 These commands are specific to \fBovsdb\-server\fR.
 118 .IP "\fBexit\fR"
 119 Causes \fBovsdb\-server\fR to gracefully terminate.
 120 .IP "\fBovsdb\-server/compact\fR [\fIdb\fR]\&..."
 121 Compacts each database \fIdb\fR in-place.  If no \fIdb\fR is
 122 specified, compacts every database in-place.  Databases are also
 123 automatically compacted occasionally.
 124 .
 125 .IP "\fBovsdb\-server/reconnect\fR"
 126 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC
 127 connections to database clients and reconnect.
 128 .IP
 129 This command might be useful for debugging issues with database
 130 clients.
 131 .
 132 .IP "\fBovsdb\-server/add\-remote \fIremote\fR"
 133 Adds a remote, as if \fB\-\-remote=\fIremote\fR had been specified on
 134 the \fBovsdb\-server\fR command line.  (If \fIremote\fR is already a
 135 remote, this command succeeds without changing the configuration.)
 136 .
 137 .IP "\fBovsdb\-server/remove\-remote \fIremote\fR"
 138 Removes the specified \fIremote\fR from the configuration, failing
 139 with an error if \fIremote\fR is not configured as a remote.  This
 140 command only works with remotes that were named on \fB\-\-remote\fR or
 141 \fBovsdb\-server/add\-remote\fR, that is, it will not remove remotes
 142 added indirectly because they were read from the database by
 143 configuring a \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR remote.
 144 (You can remove a database source with \fBovsdb\-server/remove\-remote
 145 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR, but not individual
 146 remotes found indirectly through the database.)
 147 .
 148 .IP "\fBovsdb\-server/list\-remotes"
 149 Outputs a list of the currently configured remotes named on
 150 \fB\-\-remote\fR or \fBovsdb\-server/add\-remote\fR, that is, it does
 151 not list remotes added indirectly because they were read from the
 152 database by configuring a
 153 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR remote.
 154 .
 155 .IP "\fBovsdb\-server/add\-db \fIdatabase\fR"
 156 Adds the \fIdatabase\fR to the running \fBovsdb\-server\fR.  The database
 157 file must already have been created and initialized using, for example,
 158 \fBovsdb\-tool create\fR.
 159 .
 160 .IP "\fBovsdb\-server/remove\-db \fIdatabase\fR"
 161 Removes \fIdatabase\fR from the running \fBovsdb\-server\fR.  \fIdatabase\fR
 162 must be a database name as listed by \fBovsdb-server/list\-dbs\fR.
 163 .IP
 164 If a remote has been configured that points to the specified
 165 \fIdatabase\fR (e.g. \fB\-\-remote=db:\fIdatabase\fB,\fR... on the
 166 command line), then it will be disabled until another database with
 167 the same name is added again (with \fBovsdb\-server/add\-db\fR).
 168 .IP
 169 Any public key infrastructure options specified through this database
 170 (e.g. \fB\-\-private\-key=db:\fIdatabase,\fR... on the command line)
 171 will be disabled until another database with the same name is added
 172 again (with \fBovsdb\-server/add\-db\fR).
 173 .
 174 .IP "\fBovsdb\-server/list\-dbs"
 175 Outputs a list of the currently configured databases added either through
 176 the command line or through the \fBovsdb\-server/add\-db\fR command.
 177 .
 178 .so lib/vlog-unixctl.man
 179 .so lib/memory-unixctl.man
 180 .so lib/coverage-unixctl.man
 181 .SH "SEE ALSO"
 182 .
 183 .BR ovsdb\-tool (1).