8 .TH ovsdb\-client 1 "November 2009" "Open vSwitch" "Open vSwitch Manual"
12 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
15 \fBovsdb\-client \fR[\fIoptions\fR] \fBget-schema\fI server\fR
17 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server\fR
19 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server \fR[\fItable\fR]
21 \fBovsdb\-client help\fR
22 .IP "Output formatting options:"
23 [\fB--format=\fIformat\fR]
27 .so lib/common-syn.man
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
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 .IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
39 Listen on the given TCP \fIport\fR for a connection. By default,
40 \fB\*(PN\fR listens for connections to any local IP address, but
41 \fIip\fR may be specified to listen only for connections to the given
43 .IP "\fBpunix:\fIfile\fR"
44 Listen on the Unix domain server socket named \fIfile\fR for a
48 The following commands are implemented:
49 .IP "\fBget-schema\fI server\fR"
50 Connects to \fIserver\fR, retrieves the database schema, and prints it
53 .IP "\fBlist-tables\fI server\fR"
54 Connects to \fIserver\fR, retrieves the database schema, and prints
55 a table listing the names and comments (if any) on each table within
58 .IP "\fBlist-columns\fI server \fR[\fItable\fR]"
59 Connects to \fIserver\fR, retrieves the database schema, and prints
60 a table listing the names, type, and comment (if any) on each column. If
61 \fItable\fR is specified, only columns in that table are listed;
62 otherwise, the tables include columns in all tables.
64 .SS "Output Formatting Options"
65 Much of the output from \fBovsdb\-client\fR is in the form of tables.
66 The following options controlling output formatting:
68 .IP "\fB-f \fIformat\fR"
69 .IQ "\fB--format=\fIformat\fR"
70 Sets the basic type of output formatting. The following types of
71 \fIformat\fR are available:
73 .IP "\fBtable\fR (default)"
74 Text-based tables with aligned columns.
78 Comma-separated values as defined in RFC 4180.
82 In \fBtable\fR output (the default), when standard output is a
83 terminal device, by default lines are truncated at a width of 79
84 characters. Specifying this option prevents line truncation.
86 .IP "\fB--no-heading\fR"
87 This option suppresses the heading row that otherwise appears in the
88 first row of table output.
96 \fBovsdb\-server\fR(1),
97 \fBovsdb\-client\fR(1),
98 and the OVSDB specification.