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