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 \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
23 \fBovsdb\-client help\fR
24 .IP "Output formatting options:"
25 [\fB--format=\fIformat\fR]
29 .so lib/common-syn.man
32 The \fBovsdb\-client\fR program is a command-line client for
33 interacting with a running \fBovsdb\-server\fR process. For each
34 command, the \fIserver\fR to connect to must be specified in one of
36 .IP "\fBtcp:\fIip\fB:\fIport\fR"
37 Connect to the given TCP \fIport\fR on \fIip\fR.
38 .IP "\fBunix:\fIfile\fR"
39 Connect to the Unix domain server socket named \fIfile\fR.
40 .IP "\fBptcp:\fIport\fR[\fB:\fIip\fR]"
41 Listen on the given TCP \fIport\fR for a connection. By default,
42 \fB\*(PN\fR listens for connections to any local IP address, but
43 \fIip\fR may be specified to listen only for connections to the given
45 .IP "\fBpunix:\fIfile\fR"
46 Listen on the Unix domain server socket named \fIfile\fR for a
50 The following commands are implemented:
51 .IP "\fBget-schema\fI server\fR"
52 Connects to \fIserver\fR, retrieves the database schema, and prints it
55 .IP "\fBlist-tables\fI server\fR"
56 Connects to \fIserver\fR, retrieves the database schema, and prints
57 a table listing the names and comments (if any) on each table within
60 .IP "\fBlist-columns\fI server \fR[\fItable\fR]"
61 Connects to \fIserver\fR, retrieves the database schema, and prints
62 a table listing the names, type, and comment (if any) on each column. If
63 \fItable\fR is specified, only columns in that table are listed;
64 otherwise, the tables include columns in all tables.
65 .IP "\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR"
66 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
67 which must be a JSON array containing one or more valid OVSDB
68 operations, and prints the received reply on stdout.
70 .SS "Output Formatting Options"
71 Much of the output from \fBovsdb\-client\fR is in the form of tables.
72 The following options controlling output formatting:
74 .IP "\fB-f \fIformat\fR"
75 .IQ "\fB--format=\fIformat\fR"
76 Sets the basic type of output formatting. The following types of
77 \fIformat\fR are available:
79 .IP "\fBtable\fR (default)"
80 Text-based tables with aligned columns.
84 Comma-separated values as defined in RFC 4180.
88 In \fBtable\fR output (the default), when standard output is a
89 terminal device, by default lines are truncated at a width of 79
90 characters. Specifying this option prevents line truncation.
92 .IP "\fB--no-heading\fR"
93 This option suppresses the heading row that otherwise appears in the
94 first row of table output.
102 \fBovsdb\-server\fR(1),
103 \fBovsdb\-client\fR(1),
104 and the OVSDB specification.