ovsdb-client(1)

NAME
ovsdb-client - command-line interface to ovsdb-server(1)

SYNOPSIS
ovsdb-client [options] list-dbs [server]
ovsdb-client [options] get-schema [server] [database]
ovsdb-client [options] get-schema-version [server] [database]
ovsdb-client [options] list-tables [server] [database]
ovsdb-client [options] list-columns [server] [database] [table]
ovsdb-client [options] transact [server] transaction
ovsdb-client [options] dump [server] [database]
ovsdb-client [options] monitor [server] [database] table [column[,column]...]...
ovsdb-client help

Output formatting options:
    [--format=format] [--data=format] [--no-heading] [--pretty] [--bare] [--no-heading] [--timestamp]

DESCRIPTION
The ovsdb-client program is a command-line client for interacting with a running ovsdb-server process. Each command connects to an OVSDB server, which is unix:@RUNDIR@/db.sock by default, or may be specified as server in one of the following forms:

The default database is Open_vSwitch.

  Commands
The following commands are implemented:

list-dbs [server]
    Connects to server, retrieves the list of known databases, and prints them one per line. These database names are the ones that may be used for database in the following commands.

get-schema [server] [database]
    Connects to server, retrieves the schema for database, and prints it in JSON format.

get-schema-version [server] [database]
    Connects to server, retrieves the schema for database, and prints its version number on stdout. A schema version number has the form x.y.z. See ovs-vswitchd.conf.db(5) for details.

    Schema version numbers and Open vSwitch version numbers are independent.

    If database was created before schema versioning was introduced, then it will not have a version number and this command will print a blank line.

list-tables [server] [database]
    Connects to server, retrieves the schema for database, and prints a table listing the name of each table within the database.

list-columns [server] [database] table
    Connects to server, retrieves the schema for database, and prints a table listing the name and type of each column. If table is specified, only columns in that table are listed; otherwise, the tables include columns in all tables.

transact [server] transaction
    Connects to server, sends it the specified transaction, which must be a JSON array containing one or more valid OVSDB operations, and prints the received reply on stdout.

dump [server] [database]
    Connects to server, retrieves all of the data in database, and prints it on stdout as a series of tables.

monitor [server] [database] table [column[,column]...]...
    Connects to server and monitors the contents of table in database. By default, the initial contents of table are printed, followed by each change as it occurs. If at least one column is specified, only those columns are monitored. The following column names have special meanings:

    !initial
        Do not print the initial contents of the specified columns.

    !insert
        Do not print newly inserted rows.

    !delete
        Do not print deleted rows.

    !modify
        Do not print modifications to existing rows.

    Multiple [column[,column]...] groups may be specified as separate arguments, e.g. to apply different reporting parameters to each group. Whether multiple groups or only a single group is specified, any given column may only be mentioned once on the command line.

    If --detach is used with monitor, then ovsdb-client detaches after it has successfully received and printed the initial contents of table.

OPTIONS

  Output Formatting Options
Much of the output from ovsdb-client is in the form of tables. The following options controlling output formatting:

--timestamp
    For the monitor command, adds a timestamp to each table update. Most output formats add the timestamp on a line of its own just above the table. The JSON output format puts the timestamp in a member of the top-level JSON object named time.

  Daemon Options
The daemon options apply only to the monitor command. With any other command, they have no effect.

  Logging Options

  Public Key Infrastructure Options

  Other Options

SEE ALSO
ovsdb-server(1), ovsdb-client(1), and the OVSDB specification.