ovsdb/ovsdb-server.1.in

   1 .\" -*- nroff -*-
   2 .TH ovsdb\-server 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
   3 .ds PN ovsdb\-server
   4 .
   5 .SH NAME
   6 ovsdb\-server \- Open vSwitch database server
   7 .
   8 .SH SYNOPSIS
   9 \fBovsdb\-server\fR
  10 \fIdatabase\fR
  11 [\fB--remote=\fIremote\fR]\&...
  12 .so lib/daemon-syn.man
  13 .so lib/vlog-syn.man
  14 .so lib/common-syn.man
  15 .
  16 .SH DESCRIPTION
  17 The \fBovsdb\-server\fR program provides RPC interfaces to an Open
  18 vSwitch database (OVSDB).  It supports JSON-RPC client connections
  19 over active or passive TCP/IP or Unix domain sockets.
  20 .PP
  21 The name of the OVSDB file must be specified on the command line as
  22 \fIdatabase\fR, which must already have been created and initialized
  23 using, for example, \fBovsdb\-tool create\fR.
  24 .
  25 .SH OPTIONS
  26 .
  27 .IP "\fB\-\-remote=\fIremote\fR"
  28 Adds \fIremote\fR as a connection method used by \fBovsdb\-server\fR.
  29 \fIremote\fR must take one of the following forms:
  30 .
  31 .RS
  32 .IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
  33 Listens for JSON-RPC connections on the given TCP \fIport\fR.  By
  34 default, \fB\*(PN\fR listens for connections to any local IP address,
  35 but \fIip\fR may be specified to listen only for connections to the
  36 given \fIip\fR.
  37 .
  38 .IP "\fBpunix:\fIfile\fR"
  39 Listens for JSON-RPC connections on the Unix domain server socket
  40 named \fIfile\fR.
  41 .
  42 .IP "\fBtcp:\fIip\fB:\fIport\fR"
  43 Initiates a JSON-RPC connection to the given TCP \fIport\fR on
  44 \fIip\fR and reconnects as necessary.
  45 .
  46 .IP "\fBunix:\fIfile\fR"
  47 Initiates a JSON-RPC connection to the Unix domain server socket named
  48 \fIfile\fR as reconnects as necessary.
  49 .
  50 .IP "\fBdb:\fItable\fB,\fIcolumn\fR"
  51 Reads additional connection methods from \fIcolumn\fR in all of the
  52 rows in \fItable\fR within the \fBovsdb\-server\fR database.  The
  53 \fIcolumn\fR must have type string or set of strings.  The connection
  54 methods in the column must have one of the forms described above.  As
  55 the contents of \fIcolumn\fR changes, \fBovsdb\-server\fR also adds
  56 and drops connection methods accordingly.
  57 .RE
  58 .
  59 .SS "Daemon Options"
  60 .so lib/daemon.man
  61 .SS "Logging Options"
  62 .so lib/vlog.man
  63 .SS "Other Options"
  64 .so lib/common.man
  65 .SH "RUNTIME MANAGEMENT COMMANDS"
  66 \fBovs\-appctl\fR(8) can send commands to a running
  67 \fBovsdb\-server\fR process.  The currently supported commands are
  68 described below.
  69 .so lib/vlog-unixctl.man
  70 .SH "SEE ALSO"
  71 .
  72 .BR ovsdb\-tool (1).