8 .TH ovsdb\-client 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
9 .\" This program's name:
13 ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
16 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs \fR[\fIserver\fR]
18 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]
20 \fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]
22 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]
24 \fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] [\fItable\fR]
26 \fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR
28 \fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR
30 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR
31 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
33 \fBovsdb\-client help\fR
34 .IP "Output formatting options:"
35 [\fB\-\-format=\fIformat\fR]
36 [\fB\-\-data=\fIformat\fR]
37 [\fB\-\-no-heading\fR]
40 [\fB\-\-no\-heading\fR]
42 .so lib/daemon-syn.man
45 .so lib/ssl-bootstrap-syn.man
46 .so lib/common-syn.man
49 The \fBovsdb\-client\fR program is a command-line client for
50 interacting with a running \fBovsdb\-server\fR process.
51 Each command connects to an OVSDB server, which is
52 \fBunix:@RUNDIR@/db.sock\fR by default, or may be specified as
53 \fIserver\fR in one of the following forms:
55 .so ovsdb/remote-active.man
56 .so ovsdb/remote-passive.man
59 The default \fIdatabase\fR is \fBOpen_vSwitch\fR.
62 The following commands are implemented:
63 .IP "\fBlist\-dbs \fR[\fIserver\fR]"
64 Connects to \fIserver\fR, retrieves the list of known databases, and
65 prints them one per line. These database names are the ones that may
66 be used for \fIdatabase\fR in the following commands.
68 .IP "\fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
69 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
70 prints it in JSON format.
72 .IP "\fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
73 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
74 prints its version number on stdout. A schema version number has the form
75 \fIx\fB.\fIy\fB.\fIz\fR. See \fBovs\-vswitchd.conf.db\fR(5) for
78 Schema version numbers and Open vSwitch version numbers are
81 If \fIdatabase\fR was created before schema versioning was introduced,
82 then it will not have a version number and this command will print a
85 .IP "\fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
86 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
87 prints a table listing the name of each table
90 .IP "\fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR"
91 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
92 prints a table listing the name and type of each
93 column. If \fItable\fR is specified, only columns in that table are
94 listed; otherwise, the tables include columns in all tables.
96 .IP "\fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR"
97 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
98 which must be a JSON array containing one or more valid OVSDB
99 operations, and prints the received reply on stdout.
101 .IP "\fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR"
102 Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
103 and prints it on stdout as a series of tables.
105 .IP "\fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
106 Connects to \fIserver\fR and monitors the contents of \fItable\fR in
107 \fIdatabase\fR. By default, the initial contents of \fItable\fR are
108 printed, followed by each change as it occurs. If at least one
109 \fIcolumn\fR is specified, only those columns are monitored. The
110 following \fIcolumn\fR names have special meanings:
113 Do not print the initial contents of the specified columns.
115 Do not print newly inserted rows.
117 Do not print deleted rows.
119 Do not print modifications to existing rows.
122 Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
123 as separate arguments, e.g. to apply different reporting parameters to
124 each group. Whether multiple groups or only a single group is
125 specified, any given column may only be mentioned once on the command
128 If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
129 detaches after it has successfully received and printed the initial
130 contents of \fItable\fR.
132 .SS "Output Formatting Options"
133 Much of the output from \fBovsdb\-client\fR is in the form of tables.
134 The following options controlling output formatting:
139 .IP "\fB\-\-timestamp\fR"
140 For the \fBmonitor\fR command, adds a timestamp to each table
141 update. Most output formats add the timestamp on a line of its own
142 just above the table. The JSON output format puts the timestamp in a
143 member of the top-level JSON object named \fBtime\fR.
146 The daemon options apply only to the \fBmonitor\fR command. With any
147 other command, they have no effect.
150 .SS "Logging Options"
152 .SS "Public Key Infrastructure Options"
154 .so lib/ssl-bootstrap.man
159 \fBovsdb\-server\fR(1),
160 \fBovsdb\-client\fR(1),
161 and the OVSDB specification.