ovn-ic-nb(5)                   Open vSwitch Manual                  ovn-ic-nb(5)

NAME
     ovn-ic-nb - OVN_IC_Northbound database schema

     This  database  is the interface for cloud management system (CMS), such as
     OpenStack, to configure OVN interconnection settings. The CMS produces  al‐
     most  all  of the contents of the database. The ovn-ic program monitors the
     database contents, transforms it, and stores it into the  OVN_IC_Southbound
     database.

     We  generally  speak of ``the’’ CMS, but one can imagine scenarios in which
     multiple CMSes manage different parts of OVN interconnection.

   External IDs
     Each of the tables in this database contains a special column, named exter‐‐
     nal_ids. This column has the same form and purpose each place it appears.

            external_ids: map of string-string pairs
                   Key-value pairs for use by the CMS. The CMS might use certain
                   pairs, for example, to identify entities in its own  configu‐
                   ration that correspond to those in this database.

TABLE SUMMARY
     The  following  list  summarizes  the  purpose of each of the tables in the
     OVN_IC_Northbound database.  Each table is described in more  detail  on  a
     later page.

     Table     Purpose
     IC_NB_Global
               IC Northbound configuration
     Transit_Switch
               Transit logical switch
     Transit_Router
               Transit logical router
     Transit_Router_Port
               Transit logical router
     Transit_Switch_Port
               Transit logical switch port
     SSL       SSL configuration.
     Connection
               OVSDB client connections.

IC_NB_Global TABLE
     Northbound  configuration for OVN interconnection. This table must have ex‐
     actly one row.

   Summary:
     Status:
       nb_ic_cfg                   integer
       sb_ic_cfg                   integer
     Common Columns:
       external_ids                map of string-string pairs
     Common options:
       options                     map of string-string pairs
       options : ic-backoff-interval-ms
                                   optional string
       options : ic_probe_interval
                                   optional string
       options : vxlan_mode        optional string
     Connection Options:
       connections                 set of Connections
       ssl                         optional SSL

   Details:
   Status:

     These columns allow a client to track the overall  configuration  state  of
     the system.

     nb_ic_cfg: integer
            Sequence  number for client to increment. When a client modifies the
            interconnect northbound database configuration and  wishes  to  wait
            for OVN-ICs to handle this change and update the Interconnect south‐
            bound database, it may increment this sequence number.

     sb_ic_cfg: integer
            Sequence number that one OVN-IC sets to the value of nb_ic_cfg after
            waiting  to  all the OVN-ICs finish applying their changes to inter‐
            connect southbound database.

   Common Columns:

     external_ids: map of string-string pairs
            See External IDs at the beginning of this document.

   Common options:

     options: map of string-string pairs
            This column provides general key/value settings. The  supported  op‐
            tions are described individually below.

     options : ic-backoff-interval-ms: optional string
            Upper  bound, in milliseconds, on how long ovn-ic postpones the next
            run of its incremental-processing engine. After each engine run, the
            next run is delayed by the duration of the run that  just  finished,
            capped  by  this  value. This coalesces bursts of change-driven runs
            into fewer, larger runs, trading a small amount of latency  for  re‐
            duced CPU usage when the databases are changing rapidly.

            This throttling only applies to the natural, change-driven incremen‐
            tal  path.  A forced full recompute is never delayed and always runs
            immediately.

            The default value is 0, which disables the backoff so  each  run  is
            scheduled as soon as there is work to do.

     options : ic_probe_interval: optional string
            The inactivity probe interval of the connection to the OVN IC North‐
            bound  and Southbound databases from ovn-ic, in milliseconds. If the
            value is zero, it disables the connection keepalive feature.

            If the value is nonzero, then it will be forced to  a  value  of  at
            least 1000 ms.

     options : vxlan_mode: optional string
            This field allows the client to enable VXLAN as encapsulation proto‐
            col for for cross-AZ traffic. Default value is false.

   Connection Options:

     connections: set of Connections
            Database  clients  to  which the Open vSwitch database server should
            connect or on which it should listen, along  with  options  for  how
            these connections should be configured. See the Connection table for
            more information.

     ssl: optional SSL
            Global SSL/TLS configuration.

Transit_Switch TABLE
     Each  row represents one transit logical switch for interconnection between
     different OVN deployments (availability zones).

   Summary:
     Naming:
       name                        string (must be unique within table)
     ports                         set of Transit_Switch_Ports
     Common Columns:
       other_config                map of string-string pairs
       external_ids                map of string-string pairs

   Details:
   Naming:

     name: string (must be unique within table)
            A name that uniquely identifies the transit logical switch.

     ports: set of Transit_Switch_Ports
            The transit switch’s Transit_Switch_Port ports.

   Common Columns:

     other_config: map of string-string pairs

     external_ids: map of string-string pairs
            See External IDs at the beginning of this document.

Transit_Router TABLE
     Each row represents one transit logical router for interconnection  between
     different OVN deployments (availability zones).

   Summary:
     Naming:
       name                        string (must be unique within table)
     ports                         set of Transit_Router_Ports
     Common Columns:
       other_config                map of string-string pairs
       external_ids                map of string-string pairs

   Details:
   Naming:

     name: string (must be unique within table)
            A name that uniquely identifies the transit logical router.

     ports: set of Transit_Router_Ports
            The router’s ports.

   Common Columns:

     other_config: map of string-string pairs

     external_ids: map of string-string pairs
            See External IDs at the beginning of this document.

Transit_Router_Port TABLE
     Each  row represents one transit logical router for interconnection between
     different OVN deployments (availability zones).

   Summary:
     Naming:
       name                        string (must be unique within table)
     mac                           string
     chassis                       string
     tr_uuid                       uuid
     networks                      set of strings
     Common Columns:
       other_config                map of string-string pairs

   Details:
   Naming:

     name: string (must be unique within table)
            A name that uniquely identifies the transit logical router port.

     mac: string
            The Ethernet address that belongs to this router port.

     chassis: string
            The chassis this router port should be bound to. If empty, the  port
            is local to all availability zones, that is, every availability zone
            instantiates  it as a distributed router port of its own copy of the
            transit router. This is useful for  ports  that  connect  a  transit
            router to a transit switch.

     tr_uuid: uuid
            This  is the UUID of the northbound IC logical datapath this port is
            associated with.

     networks: set of strings
            The IP addresses and netmasks  of  the  router  port.  For  example,
            192.168.0.1/24 indicates that the router’s IP address is 192.168.0.1
            and  that  packets  destined to 192.168.0.x should be routed to this
            port. These are optional.

            A  logical  router  port  always  adds  a  link-local  IPv6  address
            (fe80::/64) automatically generated from the interface’s MAC address
            using the modified EUI-64 format.

   Common Columns:

     other_config: map of string-string pairs

Transit_Switch_Port TABLE
     Each row represents one transit logical switch port for interconnection be‐
     tween different OVN deployments (availability zones).

   Summary:
     Naming:
       name                        string (must be unique within table)
     type                          string
     chassis                       string
     peer                          string
     addresses                     set of strings
     Common Columns:
       other_config                map of string-string pairs
       external_ids                map of string-string pairs

   Details:
   Naming:

     name: string (must be unique within table)
            A name that uniquely identifies the transit logical switch port.

     type: string
            The  type of the port. Set to router for a port connected to a logi‐
            cal router, or leave empty for a VIF port.

     chassis: string
            The chassis this switch port should be bound to. If empty, the  port
            is local to all availability zones.

     peer: string
            The name of the peer logical router port, used when type is router.

     addresses: set of strings
            The addresses associated with this port.

   Common Columns:

     other_config: map of string-string pairs

     external_ids: map of string-string pairs

SSL TABLE
     SSL/TLS configuration for ovn-nb database access.

   Summary:
     private_key                   string
     certificate                   string
     ca_cert                       string
     bootstrap_ca_cert             boolean
     ssl_protocols                 string
     ssl_ciphers                   string
     ssl_ciphersuites              string
     Common Columns:
       external_ids                map of string-string pairs

   Details:
     private_key: string
            Name  of  a PEM file containing the private key used as the switch’s
            identity for SSL/TLS connections to the controller.

     certificate: string
            Name of a PEM file containing a certificate, signed by the  certifi‐
            cate  authority (CA) used by the controller and manager, that certi‐
            fies the switch’s private key, identifying a trustworthy switch.

     ca_cert: string
            Name of a PEM file containing the CA certificate used to verify that
            the switch is connected to a trustworthy controller.

     bootstrap_ca_cert: boolean
            If set to true, then Open vSwitch will attempt to obtain the CA cer‐
            tificate from the controller on its  first  SSL/TLS  connection  and
            save  it to the named PEM file. If it is successful, it will immedi‐
            ately drop the connection  and  reconnect,  and  from  then  on  all
            SSL/TLS connections must be authenticated by a certificate signed by
            the  CA  certificate  thus obtained. This option exposes the SSL/TLS
            connection to a man-in-the-middle attack obtaining  the  initial  CA
            certificate. It may still be useful for bootstrapping.

     ssl_protocols: string
            Range  or  a comma- or space-delimited list of the SSL/TLS protocols
            to enable for SSL/TLS connections.

            Supported protocols include TLSv1.2 and TLSv1.3. Ranges can be  pro‐
            vided  in  a  form  of  two  protocol  names  separated  with a dash
            (TLSv1.2-TLSv1.3), or as a single protocol name  with  a  plus  sign
            (TLSv1.2+).  The  value  can  be  a list of protocols or exactly one
            range. The range is a preferred way of specifying protocols and  the
            configuration always behaves as if the range between the minimum and
            the maximum specified version is provided, i.e., if the value is set
            to  TLSv1.X,TLSv1.(X+2),  the TLSv1.(X+1) will also be enabled as if
            it was a range. Regardless of order, the highest protocol  supported
            by both sides will be chosen when making the connection.

            The default when this option is omitted is TLSv1.2+.

     ssl_ciphers: string
            List  of  ciphers  (in OpenSSL cipher string format) to be supported
            for SSL/TLS connections with TLSv1.2. The default when  this  option
            is omitted is DEFAULT:@SECLEVEL=2.

     ssl_ciphersuites: string
            List  of  ciphersuites (in OpenSSL ciphersuites string format) to be
            supported for SSL/TLS connections with TLSv1.3  and  later.  Default
            value from OpenSSL will be used when this option is omitted.

   Common Columns:

     The  overall  purpose of these columns is described under Common Columns at
     the beginning of this document.

     external_ids: map of string-string pairs

Connection TABLE
     Configuration for a database connection to an Open vSwitch database (OVSDB)
     client.

     This  table  primarily  configures  the  Open   vSwitch   database   server
     (ovsdb-server).

     The  Open  vSwitch database server can initiate and maintain active connec‐
     tions to remote clients. It can also listen for database connections.

   Summary:
     Core Features:
       target                      string (must be unique within table)
     Client Failure Detection and Handling:
       max_backoff                 optional integer, at least 1,000
       inactivity_probe            optional integer
     Status:
       is_connected                boolean
       status : last_error         optional string
       status : state              optional string, one of ACTIVE, BACKOFF, CON‐‐
                                   NECTING, IDLE, or VOID
       status : sec_since_connect
                                   optional string, containing  an  integer,  at
                                   least 0
       status : sec_since_disconnect
                                   optional  string,  containing  an integer, at
                                   least 0
       status : locks_held         optional string
       status : locks_waiting      optional string
       status : locks_lost         optional string
       status : n_connections      optional string, containing  an  integer,  at
                                   least 2
       status : bound_port         optional string, containing an integer
     Common Columns:
       external_ids                map of string-string pairs
       other_config                map of string-string pairs

   Details:
   Core Features:

     target: string (must be unique within table)
            Connection methods for clients.

            The following connection methods are currently supported:

            ssl:host[:port]
                   The  specified  SSL/TLS  port  on the host at the given host,
                   which can either be a DNS name (if  built  with  unbound  li‐
                   brary)  or  an IP address. A valid SSL/TLS configuration must
                   be provided when this form is used, this configuration can be
                   specified via command-line options or the SSL table.

                   If port is not specified, it defaults to 6640.

                   SSL/TLS support is an optional feature  that  is  not  always
                   built as part of OVN or Open vSwitch.

            tcp:host[:port]
                   The  specified  TCP port on the host at the given host, which
                   can either be a DNS name (if built with unbound  library)  or
                   an  IP address. If host is an IPv6 address, wrap it in square
                   brackets, e.g. tcp:[::1]:6640.

                   If port is not specified, it defaults to 6640.

            pssl:[port][:host]
                   Listens for SSL/TLS connections on the  specified  TCP  port.
                   Specify 0 for port to have the kernel automatically choose an
                   available  port.  If host, which can either be a DNS name (if
                   built with unbound library) or an IP address,  is  specified,
                   then  connections are restricted to the resolved or specified
                   local IPaddress (either IPv4 or IPv6 address). If host is  an
                   IPv6  address, wrap in square brackets, e.g. pssl:6640:[::1].
                   If host is not specified then it listens only  on  IPv4  (but
                   not  IPv6)  addresses.  A valid SSL/TLS configuration must be
                   provided when this form is used, this can be specified either
                   via command-line options or the SSL table.

                   If port is not specified, it defaults to 6640.

                   SSL/TLS support is an optional feature  that  is  not  always
                   built as part of OVN or Open vSwitch.

            ptcp:[port][:host]
                   Listens  for connections on the specified TCP port. Specify 0
                   for port to have the kernel automatically choose an available
                   port. If host, which can either be a DNS name (if built  with
                   unbound library) or an IP address, is specified, then connec‐
                   tions  are  restricted  to the resolved or specified local IP
                   address (either IPv4 or IPv6 address). If host is an IPv6 ad‐
                   dress, wrap it in square brackets, e.g.  ptcp:6640:[::1].  If
                   host is not specified then it listens only on IPv4 addresses.

                   If port is not specified, it defaults to 6640.

            When  multiple  clients  are  configured,  the target values must be
            unique. Duplicate target values yield unspecified results.

   Client Failure Detection and Handling:

     max_backoff: optional integer, at least 1,000
            Maximum number of milliseconds to wait between connection  attempts.
            Default is implementation-specific.

     inactivity_probe: optional integer
            Maximum  number  of  milliseconds  of idle time on connection to the
            client before sending an inactivity probe message. If  Open  vSwitch
            does  not  communicate  with  the client for the specified number of
            seconds, it will send a probe. If a response is not received for the
            same additional amount of time, Open vSwitch assumes the  connection
            has  been  broken  and attempts to reconnect. Default is implementa‐
            tion-specific. A value of 0 disables inactivity probes.

   Status:

     Key-value pair of is_connected is always updated. Other key-value pairs  in
     the status columns may be updated depends on the target type.

     When  target specifies a connection method that listens for inbound connec‐
     tions (e.g. ptcp: or punix:), both n_connections and is_connected may  also
     be updated while the remaining key-value pairs are omitted.

     On  the  other hand, when target specifies an outbound connection, all key-
     value pairs may be updated, except the above-mentioned two key-value  pairs
     associated with inbound connection targets. They are omitted.

     is_connected: boolean
            true if currently connected to this client, false otherwise.

     status : last_error: optional string
            A  human-readable description of the last error on the connection to
            the manager; i.e. strerror(errno). This key will exist  only  if  an
            error has occurred.

     status : state: optional string, one of ACTIVE, BACKOFF, CONNECTING, IDLE,
     or VOID
            The state of the connection to the manager:

            VOID   Connection is disabled.

            BACKOFF
                   Attempting to reconnect at an increasing period.

            CONNECTING
                   Attempting to connect.

            ACTIVE
                   Connected, remote host responsive.

            IDLE   Connection is idle. Waiting for response to keep-alive.

            These  values  may  change in the future. They are provided only for
            human consumption.

     status : sec_since_connect: optional string, containing an integer, at
     least 0
            The amount of time since this client last successfully connected  to
            the  database  (in seconds). Value is empty if client has never suc‐
            cessfully been connected.

     status : sec_since_disconnect: optional string, containing an integer, at
     least 0
            The amount of time since this  client  last  disconnected  from  the
            database  (in  seconds).  Value is empty if client has never discon‐
            nected.

     status : locks_held: optional string
            Space-separated list of the names of OVSDB locks that the connection
            holds. Omitted if the connection does not hold any locks.

     status : locks_waiting: optional string
            Space-separated list of the names of OVSDB locks that the connection
            is currently waiting to acquire. Omitted if the  connection  is  not
            waiting for any locks.

     status : locks_lost: optional string
            Space-separated list of the names of OVSDB locks that the connection
            has  had  stolen  by  another OVSDB client. Omitted if no locks have
            been stolen from this connection.

     status : n_connections: optional string, containing an integer, at least 2
            When target specifies a connection method that listens  for  inbound
            connections  (e.g.  ptcp:  or pssl:) and more than one connection is
            actually active, the value is the number of active connections. Oth‐
            erwise, this key-value pair is omitted.

     status : bound_port: optional string, containing an integer
            When target is ptcp: or pssl:, this is the TCP  port  on  which  the
            OVSDB  server is listening. (This is particularly useful when target
            specifies a port of 0, allowing the kernel to choose  any  available
            port.)

   Common Columns:

     The  overall  purpose of these columns is described under Common Columns at
     the beginning of this document.

     external_ids: map of string-string pairs

     other_config: map of string-string pairs

Open vSwitch 26.09.90            DB Schema 1.4.0                    ovn-ic-nb(5)