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 help\fR
  22 .IP "Output formatting options:"
  23 [\fB--format=\fIformat\fR]
  24 [\fB--wide\fR]
  25 [\fB--no-heading\fR]
  26 .so lib/vlog-syn.man
  27 .so lib/common-syn.man
  28 .
  29 .SH DESCRIPTION
  30 The \fBovsdb\-client\fR program is a command-line client for
  31 interacting with a running \fBovsdb\-server\fR process.  For each
  32 command, the \fIserver\fR to connect to must be specified in one of
  33 the following forms:
  34 .IP "\fBtcp:\fIip\fB:\fIport\fR"
  35 Connect to the given TCP \fIport\fR on \fIip\fR.
  36 .IP "\fBunix:\fIfile\fR"
  37 Connect to the Unix domain server socket named \fIfile\fR.
  38 .
  39 .SS "Commands"
  40 The following commands are implemented:
  41 .IP "\fBget-schema\fI server\fR"
  42 Connects to \fIserver\fR, retrieves the database schema, and prints it
  43 in JSON format.
  44 .
  45 .IP "\fBlist-tables\fI server\fR"
  46 Connects to \fIserver\fR, retrieves the database schema, and prints
  47 a table listing the names and comments (if any) on each table within
  48 the database.
  49 .
  50 .IP "\fBlist-columns\fI server \fR[\fItable\fR]"
  51 Connects to \fIserver\fR, retrieves the database schema, and prints
  52 a table listing the names, type, and comment (if any) on each column.  If
  53 \fItable\fR is specified, only columns in that table are listed;
  54 otherwise, the tables include columns in all tables.
  55 .SH OPTIONS
  56 .SS "Output Formatting Options"
  57 Much of the output from \fBovsdb\-client\fR is in the form of tables.
  58 The following options controlling output formatting:
  59 .
  60 .IP "\fB-f \fIformat\fR"
  61 .IQ "\fB--format=\fIformat\fR"
  62 Sets the basic type of output formatting.  The following types of
  63 \fIformat\fR are available:
  64 .RS
  65 .IP "\fBtable\fR (default)"
  66 Text-based tables with aligned columns.
  67 .IP "\fBhtml\fR"
  68 HTML tables.
  69 .IP "\fBcvs\fR"
  70 Comma-separated values as defined in RFC 4180.
  71 .RE
  72 .
  73 .IP "\fB--wide\fR"
  74 In \fBtable\fR output (the default), when standard output is a
  75 terminal device, by default lines are truncated at a width of 79
  76 characters.  Specifying this option prevents line truncation.
  77 .
  78 .IP "\fB--no-heading\fR"
  79 This option suppresses the heading row that otherwise appears in the
  80 first row of table output.
  81 .
  82 .SS "Logging Options"
  83 .so lib/vlog.man
  84 .SS "Other Options"
  85 .so lib/common.man
  86 .SH "SEE ALSO"
  87 .
  88 \fBovsdb\-server\fR(1),
  89 \fBovsdb\-client\fR(1),
  90 and the OVSDB specification.