2 .TH ovsdb\-server 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
3 .\" This program's name:
5 .\" SSL peer program's name:
9 ovsdb\-server \- Open vSwitch database server
14 [\fB\-\-remote=\fIremote\fR]\&...
15 [\fB\-\-run=\fIcommand\fR]
16 .so lib/daemon-syn.man
19 .so lib/ssl-bootstrap-syn.man
20 .so lib/unixctl-syn.man
21 .so lib/common-syn.man
24 The \fBovsdb\-server\fR program provides RPC interfaces to one or more
25 Open vSwitch databases (OVSDBs). It supports JSON-RPC client
26 connections over active or passive TCP/IP or Unix domain sockets.
28 Each OVSDB file may be specified on the command line as \fIdatabase\fR.
29 If none is specified, the default is \fB@DBDIR@/conf.db\fR. The database
30 files must already have been created and initialized using, for
31 example, \fBovsdb\-tool create\fR.
35 .IP "\fB\-\-remote=\fIremote\fR"
36 Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
37 \fIremote\fR must take one of the following forms:
40 .so ovsdb/remote-passive.man
41 .so ovsdb/remote-active.man
43 .IP "\fBdb:\fR[\fIdb\fB,\fR]\fItable\fB,\fIcolumn\fR"
44 Reads additional connection methods from \fIcolumn\fR in all of the
45 rows in \fItable\fR within \fIdb\fR. (If \fBovsdb\-server\fR is
46 providing access to only one database, then \fIdb\fR is optional.) As
47 the contents of \fIcolumn\fR changes, \fBovsdb\-server\fR also adds
48 and drops connection methods accordingly.
50 If \fIcolumn\fR's type is string or set of strings, then the
51 connection methods are taken directly from the column. The connection
52 methods in the column must have one of the forms described above.
54 If \fIcolumn\fR's type is UUID or set of UUIDs and references a table,
55 then each UUID is looked up in the referenced table to obtain a row.
56 The following columns in the row, if present and of the correct type,
57 configure a connection method. Any additional columns are ignored.
59 .IP "\fBtarget\fR (string)"
60 Connection method, in one of the forms described above. This column
61 is mandatory: if it is missing or empty then no connection method can
63 .IP "\fBmax_backoff\fR (integer)"
64 Maximum number of milliseconds to wait between connection attempts.
65 .IP "\fBinactivity_probe\fR (integer)"
66 Maximum number of milliseconds of idle time on connection to
67 client before sending an inactivity probe message.
70 It is an error for \fIcolumn\fR to have another type.
73 .IP "\fB\-\-run=\fIcommand\fR]"
74 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
75 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below). With this option,
76 \fBovsdb\-server\fR instead starts a shell subprocess running
77 \fIcommand\fR. When the subprocess terminates, \fBovsdb\-server\fR
78 also exits gracefully. If the subprocess exits normally with exit
79 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
80 otherwise, it exits with exit code 1.
82 This option can be useful where a database server is needed only to
83 run a single command, e.g.:
84 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
87 \fBovsdb\-server\fR detaches only after it starts listening on all \
92 .SS "Public Key Infrastructure Options"
93 The options described below for configuring the SSL public key
94 infrastructure accept a special syntax for obtaining their
95 configuration from the database. If any of these options is given
96 \fBdb:\fR[\fIdb\fB,\fR]\fItable\fB,\fIcolumn\fR as its argument, then the
97 actual file name is read from the specified \fIcolumn\fR in \fItable\fR
98 within the \fBovsdb\-server\fR database. The \fIcolumn\fR must have type
99 string or set of strings. The first nonempty string in the table is taken
100 as the file name. (This means that ordinarily there should be at most
101 one row in \fItable\fR.)
103 .so lib/ssl-bootstrap.man
107 .SH "RUNTIME MANAGEMENT COMMANDS"
108 \fBovs\-appctl\fR(8) can send commands to a running
109 \fBovsdb\-server\fR process. The currently supported commands are
111 .SS "OVSDB\-SERVER COMMANDS"
112 These commands are specific to \fBovsdb\-server\fR.
114 Causes \fBovsdb\-server\fR to gracefully terminate.
115 .IP "\fBovsdb\-server/compact\fR [\fIdb\fR]\&..."
116 Compacts each database \fIdb\fR in-place. If no \fIdb\fR is
117 specified, compacts every database in-place. Databases are also
118 automatically compacted occasionally.
120 .IP "\fBovsdb\-server/reconnect\fR"
121 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC
122 connections to database clients and reconnect.
124 This command might be useful for debugging issues with database
127 .so lib/vlog-unixctl.man
128 .so lib/memory-unixctl.man
129 .so lib/coverage-unixctl.man
130 .so lib/stress-unixctl.man