ovn-sbctl(8)

NAME
ovn-sbctl - utility for querying and configuring OVN_Southbound database

SYNOPSIS
ovn-sbctl [options] -- [options] command [args] [-- [options] command [args]]...

DESCRIPTION
The command should only be used for advanced debugging and troubleshooting of the OVN_Southbound database; and should never be used in normal operation.

The ovn-sbctl program configures the OVN_Southbound database by providing a high-level interface to its configuration database. See ovn-sb(5) for comprehensive documentation of the database schema.

ovn-sbctl connects to an ovsdb-server process that maintains an OVN_Southbound configuration database. Using this connection, it queries and possibly applies changes to the database, depending on the supplied commands.

ovn-sbctl can perform any number of commands in a single run, implemented as a single atomic transaction against the database.

The ovn-sbctl command line begins with global options (see OPTIONS below for details). The global options are followed by one or more commands. Each command should begin with -- by itself as a command-line argument, to separate it from the following commands. (The -- before the first command is optional.) The command itself starts with command-specific options, if any, followed by the command name and any arguments.

OPTIONS
The following options affect the behavior of ovn-sbctl as a whole. Some individual commands also accept their own options, which are given just before the command name. If the first command on the command line has options, then those options must be separated from the global options by --.

--db=server
    The OVSDB database remote to contact. If the OVN_SB_DB environment variable is set, its value is used as the default. Otherwise, the default is unix:@RUNDIR@/db.sock, but this default is unlikely to be useful outside of single-machine OVN test environments.

    server must take one of the following forms:

--no-syslog
    By default, ovn-sbctl logs its arguments and the details of any changes that it makes to the system log. This option disables this logging.

    This option is equivalent to --verbose=sbctl:syslog:warn.

--oneline
    Modifies the output format so that the output for each command is printed on a single line. New-line characters that would otherwise separate lines are printed as \n, and any instances of \ that would otherwise appear in the output are doubled. Prints a blank line for each command that has no output. This option does not affect the formatting of output from the list or find commands; see Table Formatting Options below.

--dry-run
    Prevents ovn-sbctl from actually modifying the database.

-t secs
    By default, or with a secs of 0, ovn-sbctl waits forever for a response from the database. This option limits runtime to approximately secs seconds. If the timeout expires, ovn-sbctl will exit with a SIGALRM signal. (A timeout would normally happen only if the database cannot be contacted, or if the system is overloaded.)

  Table Formatting Options
These options control the format of output from the list and find commands.

COMMANDS
The commands implemented by ovn-sbctl are described in the sections below.

  OVN_Southbound Commands
These commands work with an OVN_Southbound database as a whole.

init
    Initializes the database, if it is empty. If the database has already been initialized, this command has no effect.

show
    Prints a brief overview of the database contents.

  Chassis Commands
These commands manipulate OVN_Southbound chassis.

[--may-exist] chassis-add chassis encap-type encap-ip
    Creates a new chassis named chassis. encap-type is a comma-separated list of tunnel types. The chassis will have one encap entry for each specified tunnel type with encap-ip as the destination IP for each.

    Without --may-exist, attempting to create a chassis that exists is an error. With --may-exist, this command does nothing if chassis already exists.

[--if-exists] chassis-del chassis
    Deletes chassis and its encaps and gateway_ports.

    Without --if-exists, attempting to delete a chassis that does not exist is an error. With --if-exists, attempting to delete a chassis that does not exist has no effect.

  Port binding Commands
These commands manipulate OVN_Southbound port bindings.

[--may-exist] lsp-bind logical-port chassis
    Binds the logical port named logical-port to chassis.

    Without --may-exist, attempting to bind a logical port that has already been bound is an error. With --may-exist, this command does nothing if logical-port has already been bound to a chassis.

[--if-exists] lsp-unbind logical-port
    Resets the binding of logical-port to NULL.

    Without --if-exists, attempting to unbind a logical port that is not bound is an error. With --if-exists, attempting to unbind logical port that is not bound has no effect.

  Logical Flow Commands

lflow-list [logical-datapath]
    List logical flows. If logical-datapath is specified, only list flows for that logical datapath.

dump-flows [logical-datapath]
    Alias for lflow-list.

EXIT STATUS

0   Successful program execution.

1   Usage, syntax, or configuration file error.

SEE ALSO
ovn-sb(5).