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/service-syn.man
  21 .so lib/vlog-syn.man
  22 .so ovsdb/replication-syn.man
  23 .so lib/ssl-syn.man
  24 .so lib/ssl-bootstrap-syn.man
  25 .so lib/ssl-peer-ca-cert-syn.man
  26 .so lib/unixctl-syn.man
  27 .so lib/common-syn.man
  28 .
  29 .SH DESCRIPTION
  30 The \fBovsdb\-server\fR program provides RPC interfaces to one or more
  31 Open vSwitch databases (OVSDBs).  It supports JSON-RPC client
  32 connections over active or passive TCP/IP or Unix domain sockets.
  33 .PP
  34 Each OVSDB file may be specified on the command line as \fIdatabase\fR.
  35 If none is specified, the default is \fB@DBDIR@/conf.db\fR.  The database
  36 files must already have been created and initialized using, for
  37 example, \fBovsdb\-tool create\fR.
  38 .
  39 .SH OPTIONS
  40 .
  41 .IP "\fB\-\-remote=\fIremote\fR"
  42 Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
  43 \fIremote\fR must take one of the following forms:
  44 .
  45 .RS
  46 .so ovsdb/remote-passive.man
  47 .so ovsdb/remote-active.man
  48 .
  49 .IP "\fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR"
  50 Reads additional connection methods from \fIcolumn\fR in all of the
  51 rows in \fItable\fR within \fIdb\fR.  As the contents of \fIcolumn\fR changes,
  52 \fBovsdb\-server\fR also adds and drops connection methods accordingly.
  53 .IP
  54 If \fIcolumn\fR's type is string or set of strings, then the
  55 connection methods are taken directly from the column.  The connection
  56 methods in the column must have one of the forms described above.
  57 .IP
  58 If \fIcolumn\fR's type is UUID or set of UUIDs and references a table,
  59 then each UUID is looked up in the referenced table to obtain a row.
  60 The following columns in the row, if present and of the correct type,
  61 configure a connection method.  Any additional columns are ignored.
  62 .RS
  63 .IP "\fBtarget\fR (string)"
  64 Connection method, in one of the forms described above.  This column
  65 is mandatory: if it is missing or empty then no connection method can
  66 be configured.
  67 .IP "\fBmax_backoff\fR (integer)"
  68 Maximum number of milliseconds to wait between connection attempts.
  69 .IP "\fBinactivity_probe\fR (integer)"
  70 Maximum number of milliseconds of idle time on connection to
  71 client before sending an inactivity probe message.
  72 .RE
  73 .IP
  74 It is an error for \fIcolumn\fR to have another type.
  75 .RE
  76 .
  77 .IP
  78 To connect or listen on multiple connection methods, use multiple
  79 \fB\-\-remote\fR options.
  80 .
  81 .IP "\fB\-\-run=\fIcommand\fR]"
  82 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
  83 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
  84 \fBovsdb\-server\fR instead starts a shell subprocess running
  85 \fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
  86 also exits gracefully.  If the subprocess exits normally with exit
  87 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
  88 otherwise, it exits with exit code 1.
  89 .IP
  90 This option can be useful where a database server is needed only to
  91 run a single command, e.g.:
  92 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
  93 .IP
  94 This option is not supported on Windows platform.
  95 .SS "Daemon Options"
  96 .ds DD \
  97 \fBovsdb\-server\fR detaches only after it starts listening on all \
  98 configured remotes.
  99 .so lib/daemon.man
 100 .SS "Service Options"
 101 .so lib/service.man
 102 .SS "Logging Options"
 103 .so lib/vlog.man
 104 .SS "Syncing Options"
 105 .so ovsdb/replication.man
 106 .SS "Public Key Infrastructure Options"
 107 The options described below for configuring the SSL public key
 108 infrastructure accept a special syntax for obtaining their
 109 configuration from the database.  If any of these options is given
 110 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR as its argument, then the
 111 actual file name is read from the specified \fIcolumn\fR in \fItable\fR
 112 within the \fIdb\fR database.  The \fIcolumn\fR must have type
 113 string or set of strings.  The first nonempty string in the table is taken
 114 as the file name.  (This means that ordinarily there should be at most
 115 one row in \fItable\fR.)
 116 .so lib/ssl.man
 117 .so lib/ssl-bootstrap.man
 118 .so lib/ssl-peer-ca-cert.man
 119 .SS "Other Options"
 120 .so lib/unixctl.man
 121 .so lib/common.man
 122 .SH "RUNTIME MANAGEMENT COMMANDS"
 123 \fBovs\-appctl\fR(8) can send commands to a running
 124 \fBovsdb\-server\fR process.  The currently supported commands are
 125 described below.
 126 .SS "OVSDB\-SERVER COMMANDS"
 127 These commands are specific to \fBovsdb\-server\fR.
 128 .IP "\fBexit\fR"
 129 Causes \fBovsdb\-server\fR to gracefully terminate.
 130 .IP "\fBovsdb\-server/compact\fR [\fIdb\fR]\&..."
 131 Compacts each database \fIdb\fR in-place.  If no \fIdb\fR is
 132 specified, compacts every database in-place.  A database is also
 133 compacted automatically when a transaction is logged if it is over 4
 134 times as large as its previous compacted size (and at least 10 MB),
 135 but not before 100 commits have been added or 10 minutes have elapsed
 136 since the last compaction.
 137 .
 138 .IP "\fBovsdb\-server/reconnect\fR"
 139 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC
 140 connections to database clients and reconnect.
 141 .IP
 142 This command might be useful for debugging issues with database
 143 clients.
 144 .
 145 .IP "\fBovsdb\-server/add\-remote \fIremote\fR"
 146 Adds a remote, as if \fB\-\-remote=\fIremote\fR had been specified on
 147 the \fBovsdb\-server\fR command line.  (If \fIremote\fR is already a
 148 remote, this command succeeds without changing the configuration.)
 149 .
 150 .IP "\fBovsdb\-server/remove\-remote \fIremote\fR"
 151 Removes the specified \fIremote\fR from the configuration, failing
 152 with an error if \fIremote\fR is not configured as a remote.  This
 153 command only works with remotes that were named on \fB\-\-remote\fR or
 154 \fBovsdb\-server/add\-remote\fR, that is, it will not remove remotes
 155 added indirectly because they were read from the database by
 156 configuring a \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR remote.
 157 (You can remove a database source with \fBovsdb\-server/remove\-remote
 158 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR, but not individual
 159 remotes found indirectly through the database.)
 160 .
 161 .IP "\fBovsdb\-server/list\-remotes"
 162 Outputs a list of the currently configured remotes named on
 163 \fB\-\-remote\fR or \fBovsdb\-server/add\-remote\fR, that is, it does
 164 not list remotes added indirectly because they were read from the
 165 database by configuring a
 166 \fBdb:\fIdb\fB,\fItable\fB,\fIcolumn\fR remote.
 167 .
 168 .IP "\fBovsdb\-server/add\-db \fIdatabase\fR"
 169 Adds the \fIdatabase\fR to the running \fBovsdb\-server\fR.  The database
 170 file must already have been created and initialized using, for example,
 171 \fBovsdb\-tool create\fR.
 172 .
 173 .IP "\fBovsdb\-server/remove\-db \fIdatabase\fR"
 174 Removes \fIdatabase\fR from the running \fBovsdb\-server\fR.  \fIdatabase\fR
 175 must be a database name as listed by \fBovsdb-server/list\-dbs\fR.
 176 .IP
 177 If a remote has been configured that points to the specified
 178 \fIdatabase\fR (e.g. \fB\-\-remote=db:\fIdatabase\fB,\fR... on the
 179 command line), then it will be disabled until another database with
 180 the same name is added again (with \fBovsdb\-server/add\-db\fR).
 181 .IP
 182 Any public key infrastructure options specified through this database
 183 (e.g. \fB\-\-private\-key=db:\fIdatabase,\fR... on the command line)
 184 will be disabled until another database with the same name is added
 185 again (with \fBovsdb\-server/add\-db\fR).
 186 .
 187 .IP "\fBovsdb\-server/list\-dbs"
 188 Outputs a list of the currently configured databases added either through
 189 the command line or through the \fBovsdb\-server/add\-db\fR command.
 190 .
 191 .so lib/vlog-unixctl.man
 192 .so lib/memory-unixctl.man
 193 .so lib/coverage-unixctl.man
 194 .SH "SPECIFICATIONS"
 195 .
 196 .PP
 197 \fBovsdb\-server\fR implements the Open vSwitch Database (OVSDB)
 198 protocol specified in RFC 7047, with the following clarifications:
 199 .
 200 .IP "3.1. JSON Usage"
 201 RFC 4627 says that names within a JSON object should be unique.
 202 The Open vSwitch JSON parser discards all but the last value
 203 for a name that is specified more than once.
 204 .
 205 .IP
 206 The definition of <error> allows for implementation extensions.
 207 Currently \fBovsdb\-server\fR uses the following additional "error"
 208 strings which might change in later releases):
 209 .
 210 .RS
 211 .IP "\fBsyntax error\fR or \fBunknown column\fR"
 212 The request could not be parsed as an OVSDB request.  An additional
 213 "syntax" member, whose value is a string that contains JSON, may
 214 narrow down the particular syntax that could not be parsed.
 215 .IP "\fBinternal error\fR"
 216 The request triggered a bug in \fBovsdb\-server\fR.
 217 .IP "\fBovsdb error\fR"
 218 A map or set contains a duplicate key.
 219 .RE
 220 .
 221 .IP "3.2. Schema Format"
 222 RFC 7047 requires the "version" field in <database-schema>.  Current
 223 versions of \fBovsdb\-server\fR allow it to be omitted (future
 224 versions are likely to require it).
 225 .IP
 226 RFC 7047 allows columns that contain weak references to be immutable.
 227 This raises the issue of the behavior of the weak reference when the
 228 rows that it references are deleted.  Since version 2.6,
 229 \fBovsdb\-server\fR forces columns that contain weak references to be
 230 mutable.
 231 .
 232 .IP "4. Wire Protocol"
 233 The original OVSDB specifications included the following reason,
 234 omitted from RFC 7047, to operate JSON-RPC directly over a stream
 235 instead of over HTTP:
 236 .
 237 .RS
 238 .IP \(bu
 239 JSON-RPC is a peer-to-peer protocol, but HTTP is a client-server
 240 protocol, which is a poor match.  Thus, JSON-RPC over HTTP requires
 241 the client to periodically poll the server to receive server requests.
 242 .IP \(bu
 243 HTTP is more complicated than stream connections and doesn't provide
 244 any corresponding advantage.
 245 .IP \(bu
 246 The JSON-RPC specification for HTTP transport is incomplete.
 247 .RE
 248 .
 249 .IP "4.1.5. Monitor"
 250 For backward compatibility, \fBovsdb\-server\fR currently permits a
 251 single <monitor-request> to be used instead of an array; it is treated
 252 as a single-element array.  Future versions of \fBovsdb\-server\fR
 253 might remove this compatibility feature.
 254 .IP
 255 Because the <json-value> parameter is used to match subsequent update
 256 notifications (see below) to the request, it must be unique among all
 257 active monitors.  \fBovsdb\-server\fR rejects attempt to create two
 258 monitors with the same identifier.
 259 .
 260 .IP "4.1.12. Monitor2"
 261 A new monitor method added in Open vSwitch version 2.5. Monitor2 allows
 262 for more efficient update notifications (described below).
 263 .IP
 264 The monitor method described in Section 4.1.5 also applies to
 265 monitor2, with the following exceptions.
 266 .
 267 .RS
 268 .IP \(bu
 269 RPC request method becomes "monitor2".
 270 .IP \(bu
 271 Replay result follows <table-updates2>, described in Section 4.1.13.
 272 .IP \(bu
 273 Subsequent changes are sent to the client using the "update2" monitor
 274 notification, described in Section 4.1.13
 275 .RE
 276 .
 277 .IP
 278 Both monitor and monitor2 sessions can exist concurrently. However,
 279 monitor and monitor2 shares the same <json-value> parameter space; it
 280 must be unique among all monitor and monitor2 sessions.
 281 .
 282 .IP "4.1.13. Update2 notification"
 283 The "update2" notification is sent by the server to the client to report
 284 changes in tables that are being monitored following a "monitor2" request
 285 as described above. The notification has the following members:
 286 .
 287 .RS
 288 .nf
 289 "method": "update2"
 290 "params": [<json-value>, <table-updates2>]
 291 "id": null
 292 .fi
 293 .RE
 294 .
 295 .IP
 296 The <json-value> in "params" is the same as the value passed as the
 297 <json-value>  in "params" for the corresponding "monitor" request.
 298 <table-updates2> is an object that maps from a table name to a <table-update2>.
 299 A <table-update2> is an object that maps from row's UUID to a <row-update2> object. A <row-update2> is an object with one of the following members:
 300 .
 301 .RS
 302 .IP "\(dqinitial\(dq: <row>"
 303 present for "initial" updates
 304 .IP "\(dqinsert\(dq: <row>"
 305 present for "insert" updates
 306 .IP "\(dqdelete\(dq: <row>"
 307 present for "delete" updates
 308 .IP "\(dqmodify\(dq: <row>"
 309 present for "modify" updates
 310 .RE
 311 .
 312 .IP
 313 The format of <row> is described in Section 5.1.
 314 .
 315 .IP
 316 <row> is always a null object for a "delete" update. In "initial" and
 317 "insert" updates, <row> omits columns whose values equal the default
 318 value of the column type.
 319 .
 320 .IP
 321 For a "modify" update, <row> contains only the columns that are modified.
 322 <row> stores the difference between the old and new value for those columns,
 323 as described below.
 324 .
 325 .IP
 326 For columns with single value, the difference is the value of the new
 327 column.
 328 .
 329 .IP
 330 The difference between two sets are all elements that only belong
 331 to one of the sets.
 332 .
 333 .IP
 334 The difference between two maps are all key-value pairs whose keys
 335 appears in only one of the maps, plus the key-value pairs whose keys
 336 appear in both maps but with different values.  For the latter
 337 elements, <row> includes the value from the new column.
 338 .
 339 .IP
 340 Initial views of rows are not presented in update2 notifications,
 341 but in the response object to the monitor2 request. The formatting of the
 342 <table-updates2> object, however, is the same in either case.
 343 .
 344 .IP "5.1. Notation"
 345 For <condition>, RFC 7047 only allows the use of \fB!=\fR, \fB==\fR,
 346 \fBincludes\fR, and \fBexcludes\fR operators with set types.  Open
 347 vSwitch 2.4 and later extend <condition> to allow the use of \fB<\fR,
 348 \fB<=\fR, \fB>=\fR, and \fB>\fR operators with columns with type ``set
 349 of 0 or 1 integer'' and ``set of 0 or 1 real''.  These conditions
 350 evaluate to false when the column is empty, and otherwise as described
 351 in RFC 7047 for integer and real types.
 352 .
 353 .IP
 354 <condition> is specified in Section 5.1 in the RFC with the following change:
 355 A condition can be either a 3-element JSON array as described in the RFC or a
 356 boolean value. In case of an empty array an implicit true boolean value will be
 357 considered.
 358 .
 359 .SH "BUGS"
 360 .
 361 In Open vSwitch before version 2.4, when \fBovsdb\-server\fR sent
 362 JSON-RPC error responses to some requests, it incorrectly formulated
 363 them with the \fBresult\fR and \fBerror\fR swapped, so that the
 364 response appeared to indicate success (with a nonsensical result)
 365 rather than an error.  The requests that suffered from this problem
 366 were:
 367 .
 368 .IP \fBtransact\fR
 369 .IQ \fBget_schema\fR
 370 Only if the request names a nonexistent database.
 371 .IP \fBmonitor\fR
 372 .IQ \fBlock\fR
 373 .IQ \fBunlock\fR
 374 In all error cases.
 375 .
 376 .PP
 377 Of these cases, the only error that a well-written application is
 378 likely to encounter in practice is \fBmonitor\fR of tables or columns
 379 that do not exist, in an situation where the application has been
 380 upgraded but the old database schema is still temporarily in use.  To
 381 handle this situation gracefully, we recommend that clients should
 382 treat a \fBmonitor\fR response with a \fBresult\fR that contains an
 383 \fBerror\fR key-value pair as an error (assuming that the database
 384 being monitored does not contain a table named \fBerror\fR).
 385 .
 386 .SH "SEE ALSO"
 387 .
 388 .BR ovsdb\-tool (1).