ovsdb/ovsdb-client.1.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .\" -*- nroff -*-
   8 .TH ovsdb\-client 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
   9 .\" This program's name:
  10 .ds PN ovsdb\-client
  11 .\" SSL peer program's name:
  12 .ds SN ovsdb\-server
  13 .
  14 .SH NAME
  15 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
  16 .
  17 .SH SYNOPSIS
  18 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs\fI server\fR
  19 .br
  20 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
  21 .br
  22 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\-version\fI server database\fR
  23 .br
  24 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI server database\fR
  25 .br
  26 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI server database \fR[\fItable\fR]
  27 .br
  28 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
  29 .br
  30 \fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI server database\fR
  31 .br
  32 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI server database table\fR
  33 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
  34 .br
  35 \fBovsdb\-client help\fR
  36 .IP "Output formatting options:"
  37 [\fB\-\-format=\fIformat\fR]
  38 [\fB\-\-no\-heading\fR]
  39 .so lib/daemon-syn.man
  40 .so lib/vlog-syn.man
  41 .so lib/ssl-syn.man
  42 .so lib/ssl-bootstrap-syn.man
  43 .so lib/common-syn.man
  44 .
  45 .SH DESCRIPTION
  46 The \fBovsdb\-client\fR program is a command-line client for
  47 interacting with a running \fBovsdb\-server\fR process.  For each
  48 command, the \fIserver\fR to connect to must be specified in one of
  49 the following forms:
  50 .RS
  51 .so ovsdb/remote-active.man
  52 .so ovsdb/remote-passive.man
  53 .RE
  54 .
  55 .SS "Commands"
  56 The following commands are implemented:
  57 .IP "\fBlist\-dbs\fI server\fR"
  58 Connects to \fIserver\fR, retrieves the list of known databases, and
  59 prints them one per line.  These database names are the ones that may
  60 be used for \fIdatabase\fR in the following commands.
  61 .
  62 .IP "\fBget\-schema\fI server database\fR"
  63 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
  64 prints it in JSON format.
  65 .
  66 .IP "\fBget\-schema\-version\fI server database\fR"
  67 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
  68 prints its version number on stdout.  A schema version number has the form
  69 \fIx\fB.\fIy\fB.\fIz\fR.  See \fBovs\-vswitchd.conf.db\fR(5) for
  70 details.
  71 .IP
  72 Schema version numbers and Open vSwitch version numbers are
  73 independent.
  74 .IP
  75 If \fIdatabase\fR was created before schema versioning was introduced,
  76 then it will not have a version number and this command will print a
  77 blank line.
  78 .
  79 .IP "\fBlist\-tables\fI server database\fR"
  80 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
  81 prints a table listing the name of each table
  82 within the database.
  83 .
  84 .IP "\fBlist\-columns\fI server database \fR[\fItable\fR]"
  85 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
  86 prints a table listing the name and type of each
  87 column.  If \fItable\fR is specified, only columns in that table are
  88 listed; otherwise, the tables include columns in all tables.
  89 .
  90 .IP "\fBtransact\fI server transaction\fR"
  91 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
  92 which must be a JSON array containing one or more valid OVSDB
  93 operations, and prints the received reply on stdout.
  94 .
  95 .IP "\fBdump\fI server database\fR"
  96 Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
  97 and prints it on stdout as a series of tables.
  98 .
  99 .IP "\fBmonitor\fI server database table\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
 100 Connects to \fIserver\fR and monitors the contents of \fItable\fR in
 101 \fIdatabase\fR.  By default, the initial contents of \fItable\fR are
 102 printed, followed by each change as it occurs.  If at least one
 103 \fIcolumn\fR is specified, only those columns are monitored.  The
 104 following \fIcolumn\fR names have special meanings:
 105 .RS
 106 .IP "\fB!initial\fR"
 107 Do not print the initial contents of the specified columns.
 108 .IP "\fB!insert\fR"
 109 Do not print newly inserted rows.
 110 .IP "\fB!delete\fR"
 111 Do not print deleted rows.
 112 .IP "\fB!modify\fR"
 113 Do not print modifications to existing rows.
 114 .RE
 115 .IP
 116 Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
 117 as separate arguments, e.g. to apply different reporting parameters to
 118 each group.  Whether multiple groups or only a single group is
 119 specified, any given column may only be mentioned once on the command
 120 line.
 121 .IP
 122 If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
 123 detaches after it has successfully received and printed the initial
 124 contents of \fItable\fR.
 125 .SH OPTIONS
 126 .SS "Output Formatting Options"
 127 Much of the output from \fBovsdb\-client\fR is in the form of tables.
 128 The following options controlling output formatting:
 129 .
 130 .ds TD (default)
 131 .so lib/table.man
 132 .
 133 .SS "Daemon Options"
 134 The daemon options apply only to the \fBmonitor\fR command.  With any
 135 other command, they have no effect.
 136 .so lib/daemon.man
 137 .SS "Logging Options"
 138 .so lib/vlog.man
 139 .SS "Public Key Infrastructure Options"
 140 .so lib/ssl.man
 141 .so lib/ssl-bootstrap.man
 142 .SS "Other Options"
 143 .so lib/common.man
 144 .SH "SEE ALSO"
 145 .
 146 \fBovsdb\-server\fR(1),
 147 \fBovsdb\-client\fR(1),
 148 and the OVSDB specification.