ovsdb/ovsdb-tool.1.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .\" -*- nroff -*-
   8 .TH ovsdb\-tool 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
   9 .ds PN ovsdb\-tool
  10 .
  11 .SH NAME
  12 ovsdb\-tool \- Open vSwitch database management utility
  13 .
  14 .SH SYNOPSIS
  15 \fBovsdb\-tool \fR[\fIoptions\fR] \fBcreate\fI db schema\fR
  16 .br
  17 \fBovsdb\-tool \fR[\fIoptions\fR] \fBquery\fI db transaction\fR
  18 .br
  19 \fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR
  20 .br
  21 \fBovsdb\-tool \fR[\fIoptions\fR] [\fB-m\fR | \fB--more\fR]... \fBshow\-log\fI db\fR
  22 .br
  23 \fBovsdb\-tool help\fR
  24 .so lib/vlog-syn.man
  25 .so lib/common-syn.man
  26 .
  27 .SH DESCRIPTION
  28 The \fBovsdb\-tool\fR program is a command-line tool for managing Open
  29 vSwitch database (OVSDB) files.  It does not interact directly with
  30 running Open vSwitch database servers (instead, use
  31 \fBovsdb\-client\fR).
  32 .
  33 .SS "Basic Commands"
  34 .IP "\fBcreate\fI db schema\fR"
  35 Reads an OVSDB schema from the file named \fIschema\fR and creates a
  36 new OVSDB database file named \fIdb\fR using that schema.  The new
  37 database is initially empty.  This command will not overwrite an
  38 existing \fIdb\fR.
  39 .IP
  40 \fIschema\fR must contain an OVSDB schema in JSON format.  Refer to
  41 the OVSDB specification for details.
  42 .
  43 .IP "\fBquery\fI db transaction\fR"
  44 Opens \fIdb\fR, executes \fItransaction\fR on it, and prints the
  45 results.  The \fItransaction\fR must be a JSON array in the format of
  46 the \fBparams\fR array for the JSON-RPC \fBtransact\fR method, as
  47 described in the OVSDB specification.
  48 .IP
  49 The \fIdb\fR is opened for read-only access, so this command may
  50 safely run concurrently with other database activity, including
  51 \fBovsdb-server\fR and other database writers.  The \fItransaction\fR
  52 may specify database modifications, but these will have no effect on
  53 \fIdb\fR.
  54 .
  55 .IP "\fBtransact\fI db transaction\fR"
  56 Opens \fIdb\fR, executes \fItransaction\fR on it, prints the results,
  57 and commits any changes to \fIdb\fR.  The \fItransaction\fR must be a
  58 JSON array in the format of the \fBparams\fR array for the JSON-RPC
  59 \fBtransact\fR method, as described in the OVSDB specification.
  60 .IP
  61 The \fIdb\fR is opened and locked for read/write access, so this
  62 command will fail if the database is opened for writing by any other
  63 process, including \fBovsdb-server\fR(1).  Use \fBovsdb\-client\fR(1),
  64 instead, to write to a database that is served by
  65 \fBovsdb-server\fR(1).
  66 .
  67 .IP "\fBshow-log\fI db\fR"
  68 Prints a summary of the records in \fBdb\fR's log, including the time
  69 and date at which each database change occurred and any associated
  70 comment.  This may be useful for debugging.
  71 .PP
  72 To increase the verbosity of output, add \fB-m\fR (or \fB--more\fR)
  73 one or more times to the command line.  With one \fB-m\fR,
  74 \fBshow\-log\fR prints a summary of the records added, deleted, or
  75 modified by each transaction.  With two \fB-m\fRs, \fBshow\-log\fR
  76 also prints the values of the columns modified by each change to a
  77 record.
  78 .
  79 .SH OPTIONS
  80 .SS "Logging Options"
  81 .so lib/vlog.man
  82 .SS "Other Options"
  83 .so lib/common.man
  84 .SH "SEE ALSO"
  85 .
  86 \fBovsdb\-server\fR(1),
  87 \fBovsdb\-client\fR(1),
  88 and the OVSDB specification.