Debian: Add Homepage
[openvswitch] / 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 .\" This program's name:
10 .ds PN ovsdb\-client
11 .\" SSL peer program's name:
12 .ds SN ovsdb\-server
13 .
14 .SH NAME
15 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
16 .
17 .SH SYNOPSIS
18 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs\fI server\fR
19 .br
20 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
21 .br
22 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI server database\fR
23 .br
24 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI server database \fR[\fItable\fR]
25 .br
26 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
27 .br
28 \fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI server database\fR
29 .br
30 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI server database table\fR
31 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
32 .br
33 \fBovsdb\-client help\fR
34 .IP "Output formatting options:"
35 [\fB\-\-format=\fIformat\fR]
36 [\fB\-\-no\-heading\fR]
37 .so lib/daemon-syn.man
38 .so lib/vlog-syn.man
39 .so lib/ssl-syn.man
40 .so lib/ssl-bootstrap-syn.man
41 .so lib/common-syn.man
42 .
43 .SH DESCRIPTION
44 The \fBovsdb\-client\fR program is a command-line client for
45 interacting with a running \fBovsdb\-server\fR process.  For each
46 command, the \fIserver\fR to connect to must be specified in one of
47 the following forms:
48 .RS
49 .so ovsdb/remote-active.man
50 .so ovsdb/remote-passive.man
51 .RE
52 .
53 .SS "Commands"
54 The following commands are implemented:
55 .IP "\fBlist\-dbs\fI server\fR"
56 Connects to \fIserver\fR, retrieves the list of known databases, and
57 prints them one per line.  These database names are the ones that may
58 be used for \fIdatabase\fR in the following commands.
59 .
60 .IP "\fBget\-schema\fI server database\fR"
61 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
62 prints it in JSON format.
63 .
64 .IP "\fBlist\-tables\fI server database\fR"
65 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
66 prints a table listing the name of each table
67 within the database.
68 .
69 .IP "\fBlist\-columns\fI server database \fR[\fItable\fR]"
70 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
71 prints a table listing the name and type of each
72 column.  If \fItable\fR is specified, only columns in that table are
73 listed; otherwise, the tables include columns in all tables.
74 .
75 .IP "\fBtransact\fI server transaction\fR"
76 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
77 which must be a JSON array containing one or more valid OVSDB
78 operations, and prints the received reply on stdout.
79 .
80 .IP "\fBdump\fI server database\fR"
81 Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
82 and prints it on stdout as a series of tables.
83 .
84 .IP "\fBmonitor\fI server database table\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
85 Connects to \fIserver\fR and monitors the contents of \fItable\fR in
86 \fIdatabase\fR.  By default, the initial contents of \fItable\fR are
87 printed, followed by each change as it occurs.  If at least one
88 \fIcolumn\fR is specified, only those columns are monitored.  The
89 following \fIcolumn\fR names have special meanings:
90 .RS
91 .IP "\fB!initial\fR"
92 Do not print the initial contents of the specified columns.
93 .IP "\fB!insert\fR"
94 Do not print newly inserted rows.
95 .IP "\fB!delete\fR"
96 Do not print deleted rows.
97 .IP "\fB!modify\fR"
98 Do not print modifications to existing rows.
99 .RE
100 .IP
101 Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
102 as separate arguments, e.g. to apply different reporting parameters to
103 each group.  Whether multiple groups or only a single group is
104 specified, any given column may only be mentioned once on the command
105 line.
106 .IP
107 If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
108 detaches after it has successfully received and printed the initial
109 contents of \fItable\fR.
110 .SH OPTIONS
111 .SS "Output Formatting Options"
112 Much of the output from \fBovsdb\-client\fR is in the form of tables.
113 The following options controlling output formatting:
114 .
115 .IP "\fB\-f \fIformat\fR"
116 .IQ "\fB\-\-format=\fIformat\fR"
117 Sets the type of table formatting.  The following types of
118 \fIformat\fR are available:
119 .RS
120 .IP "\fBtable\fR (default)"
121 Text-based tables with aligned columns.
122 .IP "\fBhtml\fR"
123 HTML tables.
124 .IP "\fBcvs\fR"
125 Comma-separated values as defined in RFC 4180.
126 .RE
127 .
128 .IP "\fB\-d \fIformat\fR"
129 .IP "\fB\-\-data=\fIformat\fR"
130 Sets the formatting for cells within output tables.  The following
131 types of \fIformat\fR are available:
132 .RS
133 .IP "\fBstring\fR (default)"
134 The simple format described in \fBovs\-vsctl\fR(8).
135 .IP "\fBjson\fR"
136 JSON.
137 .RE
138 .
139 .IP "\fB\-\-no\-heading\fR"
140 This option suppresses the heading row that otherwise appears in the
141 first row of table output.
142 .
143 .IP "\fB\-\-pretty\fR"
144 By default, JSON in output is printed as compactly as possible.  This
145 option causes JSON in output to be printed in a more readable
146 fashion.  Members of objects and elements of arrays are printed one
147 per line, with indentation.
148 .IP
149 This option does not affect JSON in tables, which is always printed
150 compactly.
151 .
152 .SS "Daemon Options"
153 The daemon options apply only to the \fBmonitor\fR command.  With any
154 other command, they have no effect.
155 .so lib/daemon.man
156 .SS "Logging Options"
157 .so lib/vlog.man
158 .SS "Public Key Infrastructure Options"
159 .so lib/ssl.man
160 .so lib/ssl-bootstrap.man
161 .SS "Other Options"
162 .so lib/common.man
163 .SH "SEE ALSO"
164 .
165 \fBovsdb\-server\fR(1),
166 \fBovsdb\-client\fR(1),
167 and the OVSDB specification.