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 .ds PN ovsdb\-client
  10 .
  11 .SH NAME
  12 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
  13 .
  14 .SH SYNOPSIS
  15 \fBovsdb\-client \fR[\fIoptions\fR] \fBget-schema\fI server\fR
  16 .br
  17 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server\fR
  18 .br
  19 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server \fR[\fItable\fR]
  20 .br
  21 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
  22 .br
  23 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI server table\fR
  24 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]
  25 [\fIselect\fR[\fB,\fIselect\fR]...]
  26 .br
  27 \fBovsdb\-client help\fR
  28 .IP "Output formatting options:"
  29 [\fB--format=\fIformat\fR]
  30 [\fB--wide\fR]
  31 [\fB--no-heading\fR]
  32 .so lib/vlog-syn.man
  33 .so lib/common-syn.man
  34 .
  35 .SH DESCRIPTION
  36 The \fBovsdb\-client\fR program is a command-line client for
  37 interacting with a running \fBovsdb\-server\fR process.  For each
  38 command, the \fIserver\fR to connect to must be specified in one of
  39 the following forms:
  40 .IP "\fBtcp:\fIip\fB:\fIport\fR"
  41 Connect to the given TCP \fIport\fR on \fIip\fR.
  42 .IP "\fBunix:\fIfile\fR"
  43 Connect to the Unix domain server socket named \fIfile\fR.
  44 .IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
  45 Listen on the given TCP \fIport\fR for a connection.  By default,
  46 \fB\*(PN\fR listens for connections to any local IP address, but
  47 \fIip\fR may be specified to listen only for connections to the given
  48 \fIip\fR.
  49 .IP "\fBpunix:\fIfile\fR"
  50 Listen on the Unix domain server socket named \fIfile\fR for a
  51 connection.
  52 .
  53 .SS "Commands"
  54 The following commands are implemented:
  55 .IP "\fBget-schema\fI server\fR"
  56 Connects to \fIserver\fR, retrieves the database schema, and prints it
  57 in JSON format.
  58 .
  59 .IP "\fBlist-tables\fI server\fR"
  60 Connects to \fIserver\fR, retrieves the database schema, and prints
  61 a table listing the names and comments (if any) on each table within
  62 the database.
  63 .
  64 .IP "\fBlist-columns\fI server \fR[\fItable\fR]"
  65 Connects to \fIserver\fR, retrieves the database schema, and prints
  66 a table listing the names, type, and comment (if any) on each column.  If
  67 \fItable\fR is specified, only columns in that table are listed;
  68 otherwise, the tables include columns in all tables.
  69 .
  70 .IP "\fBtransact\fI server transaction\fR"
  71 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
  72 which must be a JSON array containing one or more valid OVSDB
  73 operations, and prints the received reply on stdout.
  74 .
  75 .IP "\fBmonitor\fI server table\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...] [\fIselect\fR[\fB,\fIselect\fR]...]"
  76 Connects to \fIserver\fR and monitors the contents of \fItable\fR.  By
  77 default, the initial contents of \fItable\fR are printed, followed by
  78 each change as it occurs.  If at least one \fIcolumn\fR is specified,
  79 only those columns are monitored.  If at least one \fIselect\fR is
  80 specified, they are interpreted as follows:
  81 .RS
  82 .IP "\fBinitial\fR"
  83 Print the initial contents of the specified columns.
  84 .IP "\fBinsert\fR"
  85 Print newly inserted rows.
  86 .IP "\fBdelete\fR"
  87 Print deleted rows.
  88 .IP "\fBmodify\fR"
  89 Print old and new values of modified rows.
  90 .RE
  91 .SH OPTIONS
  92 .SS "Output Formatting Options"
  93 Much of the output from \fBovsdb\-client\fR is in the form of tables.
  94 The following options controlling output formatting:
  95 .
  96 .IP "\fB-f \fIformat\fR"
  97 .IQ "\fB--format=\fIformat\fR"
  98 Sets the basic type of output formatting.  The following types of
  99 \fIformat\fR are available:
 100 .RS
 101 .IP "\fBtable\fR (default)"
 102 Text-based tables with aligned columns.
 103 .IP "\fBhtml\fR"
 104 HTML tables.
 105 .IP "\fBcvs\fR"
 106 Comma-separated values as defined in RFC 4180.
 107 .RE
 108 .
 109 .IP "\fB--wide\fR"
 110 In \fBtable\fR output (the default), when standard output is a
 111 terminal device, by default lines are truncated at a width of 79
 112 characters.  Specifying this option prevents line truncation.
 113 .
 114 .IP "\fB--no-heading\fR"
 115 This option suppresses the heading row that otherwise appears in the
 116 first row of table output.
 117 .
 118 .SS "Logging Options"
 119 .so lib/vlog.man
 120 .SS "Other Options"
 121 .so lib/common.man
 122 .SH "SEE ALSO"
 123 .
 124 \fBovsdb\-server\fR(1),
 125 \fBovsdb\-client\fR(1),
 126 and the OVSDB specification.