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--connect \fIremote\fR]\&...
  12 [\fB--listen \fIlocal\fR]\&...
  13 .so lib/daemon-syn.man
  14 .so lib/vlog-syn.man
  15 .so lib/common-syn.man
  16 .
  17 .SH DESCRIPTION
  18 The \fBovsdb\-server\fR program provides RPC interfaces to an Open
  19 vSwitch database (OVSDB).  It can listen for JSON-RPC connections from
  20 TCP/IP or Unix domain socket clients (with \fB\-\-listen\fR), connect to
  21 remote JSON-RPC TCP/IP or Unix domain socket clients (with
  22 \fB\-\-connect\fR).
  23 .PP
  24 The name of the OVSDB file must be specified on the command line as
  25 \fIdatabase\fR, which must already have been created and initialized
  26 using, for example, \fBovsdb\-tool create\fR.
  27 .
  28 .SH OPTIONS
  29 .
  30 .IP "\fB\-\-listen=\fIlocal\fR"
  31 Makes \fBovsdb\-server\fR listen for JSON-RPC connections on
  32 \fIlocal\fR, which must take one of the following forms:
  33 .
  34 .RS
  35 .IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
  36 Listens for JSON-RPC connections on the given TCP \fIport\fR.  By
  37 default, \fB\*(PN\fR listens for connections to any local IP address,
  38 but \fIip\fR may be specified to listen only for connections to the
  39 given \fIip\fR.
  40 .IP "\fBpunix:\fIfile\fR"
  41 Listens for JSON-RPC connections on the Unix domain server socket
  42 named \fIfile\fR.
  43 .RE
  44 .
  45 .IP "\fB\-\-connect=\fIremote\fR"
  46 Makes \fBovsdb\-server\fR initiate a JSON-RPC connection to
  47 \fIremote\fR, which must take one of the forms listed below.  The
  48 server will reconnect to \fIremote\fR as necessary.
  49 .
  50 .RS
  51 .IP "\fBtcp:\fIip\fB:\fIport\fR"
  52 Connects to the given TCP \fIport\fR on \fIip\fR.
  53 .IP "\fBunix:\fIfile\fR"
  54 Connects to the Unix domain server socket named \fIfile\fR.
  55 .RE
  56 .
  57 .SS "Daemon Options"
  58 .so lib/daemon.man
  59 .SS "Logging Options"
  60 .so lib/vlog.man
  61 .SS "Other Options"
  62 .so lib/common.man
  63 .SH "RUNTIME MANAGEMENT COMMANDS"
  64 \fBovs\-appctl\fR(8) can send commands to a running
  65 \fBovsdb\-server\fR process.  The currently supported commands are
  66 described below.
  67 .so lib/vlog-unixctl.man
  68 .SH "SEE ALSO"
  69 .
  70 .BR ovsdb\-tool (1).