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