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