Add "Manager" and "manager_options" to allow options for OVSDB connections.
[cascardo/ovs.git] / 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.  As the contents of \fIcolumn\fR changes,
45 \fBovsdb\-server\fR also adds and drops connection methods
46 accordingly.
47 .IP
48 If \fIcolumn\fR's type is string or set of strings, then the
49 connection methods are taken directly from the column.  The connection
50 methods in the column must have one of the forms described above.
51 .IP
52 If \fIcolumn\fR's type is UUID or set of UUIDs and references a table,
53 then each UUID is looked up in the referenced table to obtain a row.
54 The following columns in the row, if present and of the correct type,
55 configure a connection method.  Any additional columns are ignored.
56 .RS
57 .IP "\fBtarget\fR (string)"
58 Connection method, in one of the forms described above.  This column
59 is mandatory: if it is missing or empty then no connection method can
60 be configured.
61 .IP "\fBmax_backoff\fR (integer)"
62 Maximum number of milliseconds to wait between connection attempts.
63 .IP "\fBinactivity_probe\fR (integer)
64 Maximum number of milliseconds of idle time on connection to
65 client before sending an inactivity probe message.
66 .RE
67 .IP
68 It is an error for \fIcolumn\fR to have another type.
69 .RE
70 .
71 .IP "\fB\-\-run=\fIcommand\fR]"
72 Ordinarily \fBovsdb\-server\fR runs forever, or until it is told to
73 exit (see \fBRUNTIME MANAGEMENT COMMANDS\fR below).  With this option,
74 \fBovsdb\-server\fR instead starts a shell subprocess running
75 \fIcommand\fR.  When the subprocess terminates, \fBovsdb\-server\fR
76 also exits gracefully.  If the subprocess exits normally with exit
77 code 0, then \fBovsdb\-server\fR exits with exit code 0 also;
78 otherwise, it exits with exit code 1.
79 .IP
80 This option can be useful where a database server is needed only to
81 run a single command, e.g.:
82 .B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
83 .SS "Daemon Options"
84 .so lib/daemon.man
85 .SS "Logging Options"
86 .so lib/vlog.man
87 .SS "Public Key Infrastructure Options"
88 The options described below for configuring the SSL public key
89 infrastructure accept a special syntax for obtaining their
90 configuration from the database.  If any of these options is given
91 \fBdb:\fItable\fB,\fIcolumn\fR as its argument, then the actual file
92 name is read from the specified \fIcolumn\fR in \fItable\fR within the
93 \fBovsdb\-server\fR database.  The \fIcolumn\fR must have type string
94 or set of strings.  The first nonempty string in the table is taken as
95 the file name.  (This means that ordinarily there should be at most
96 one row in \fItable\fR.)
97 .so lib/ssl.man
98 .so lib/ssl-bootstrap.man
99 .SS "Other Options"
100 .so lib/unixctl.man
101 .so lib/common.man
102 .SH "RUNTIME MANAGEMENT COMMANDS"
103 \fBovs\-appctl\fR(8) can send commands to a running
104 \fBovsdb\-server\fR process.  The currently supported commands are
105 described below.
106 .SS "OVSDB\-SERVER COMMANDS"
107 These commands are specific to \fBovsdb\-server\fR.
108 .IP "\fBexit\fR"
109 Causes \fBovsdb\-server\fR to gracefully terminate.
110 .IP "\fBovsdb\-server/compact\fR"
111 Compacts the database in-place.  The database is also automatically
112 compacted occasionally.
113 .
114 .IP "\fBovsdb\-server/reconnect\fR"
115 Makes \fBovsdb\-server\fR drop all of the JSON\-RPC
116 connections to database clients and reconnect.
117 .IP
118 This command might be useful for debugging issues with database
119 clients.
120 .
121 .so lib/vlog-unixctl.man
122 .SH "SEE ALSO"
123 .
124 .BR ovsdb\-tool (1).