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