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 [\fItable\fR
31 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR
32 [\fIcolumn\fR[\fB,\fIcolumn\fR]...]...
34 \fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fBALL\fR
36 \fBovsdb\-client help\fR
37 .IP "Output formatting options:"
38 [\fB\-\-format=\fIformat\fR]
39 [\fB\-\-data=\fIformat\fR]
40 [\fB\-\-no-heading\fR]
43 [\fB\-\-no\-heading\fR]
45 .so lib/daemon-syn.man
48 .so lib/ssl-bootstrap-syn.man
49 .so lib/common-syn.man
52 The \fBovsdb\-client\fR program is a command-line client for
53 interacting with a running \fBovsdb\-server\fR process.
54 Each command connects to an OVSDB server, which is
55 \fBunix:@RUNDIR@/db.sock\fR by default, or may be specified as
56 \fIserver\fR in one of the following forms:
58 .so ovsdb/remote-active.man
59 .so ovsdb/remote-passive.man
62 The default \fIdatabase\fR is \fBOpen_vSwitch\fR.
65 The following commands are implemented:
66 .IP "\fBlist\-dbs \fR[\fIserver\fR]"
67 Connects to \fIserver\fR, retrieves the list of known databases, and
68 prints them one per line. These database names are the ones that may
69 be used for \fIdatabase\fR in the following commands.
71 .IP "\fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
72 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
73 prints it in JSON format.
75 .IP "\fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
76 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
77 prints its version number on stdout. A schema version number has the form
78 \fIx\fB.\fIy\fB.\fIz\fR. See \fBovs\-vswitchd.conf.db\fR(5) for
81 Schema version numbers and Open vSwitch version numbers are
84 If \fIdatabase\fR was created before schema versioning was introduced,
85 then it will not have a version number and this command will print a
88 .IP "\fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]"
89 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
90 prints a table listing the name of each table
93 .IP "\fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR"
94 Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
95 prints a table listing the name and type of each
96 column. If \fItable\fR is specified, only columns in that table are
97 listed; otherwise, the tables include columns in all tables.
99 .IP "\fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR"
100 Connects to \fIserver\fR, sends it the specified \fItransaction\fR,
101 which must be a JSON array containing one or more valid OVSDB
102 operations, and prints the received reply on stdout.
104 .IP "\fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR [\fItable \fR[\fIcolumn\fR...]]"
105 Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR,
106 and prints it on stdout as a series of tables. If \fItable\fR is
107 specified, only that table is retrieved. If at least one \fIcolumn\fR
108 is specified, only those columns are retrieved.
110 .IP "\fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..."
111 Connects to \fIserver\fR and monitors the contents of \fItable\fR in
112 \fIdatabase\fR. By default, the initial contents of \fItable\fR are
113 printed, followed by each change as it occurs. If at least one
114 \fIcolumn\fR is specified, only those columns are monitored. The
115 following \fIcolumn\fR names have special meanings:
118 Do not print the initial contents of the specified columns.
120 Do not print newly inserted rows.
122 Do not print deleted rows.
124 Do not print modifications to existing rows.
127 Multiple [\fIcolumn\fR[\fB,\fIcolumn\fR]...] groups may be specified
128 as separate arguments, e.g. to apply different reporting parameters to
129 each group. Whether multiple groups or only a single group is
130 specified, any given column may only be mentioned once on the command
133 If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
134 detaches after it has successfully received and printed the initial
135 contents of \fItable\fR.
137 .IP "\fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fBALL\fR"
138 Connects to \fIserver\fR and monitors the contents of all tables in
139 \fIdatabase\fR. Prints initial values and all kinds of changes to all
140 columns in the database. The \fB\-\-detach\fR option causes
141 \fBovsdb\-client\fR to detach after it successfully receives and
142 prints the initial database contents.
145 .SS "Output Formatting Options"
146 Much of the output from \fBovsdb\-client\fR is in the form of tables.
147 The following options controlling output formatting:
152 .IP "\fB\-\-timestamp\fR"
153 For the \fBmonitor\fR command, adds a timestamp to each table
154 update. Most output formats add the timestamp on a line of its own
155 just above the table. The JSON output format puts the timestamp in a
156 member of the top-level JSON object named \fBtime\fR.
159 The daemon options apply only to the \fBmonitor\fR command. With any
160 other command, they have no effect.
163 .SS "Logging Options"
165 .SS "Public Key Infrastructure Options"
167 .so lib/ssl-bootstrap.man
172 \fBovsdb\-server\fR(1),
173 \fBovsdb\-client\fR(1),
174 and the OVSDB specification.