ovn/controller-vtep/ovn-controller-vtep.8.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <manpage program="ovn-controller-vtep" section="8" title="ovn-controller-vtep">
   3     <h1>Name</h1>
   4     <p>ovn-controller-vtep -- Open Virtual Network local controller for
   5        vtep enabled physical switches.
   6     </p>
   7
   8     <h1>Synopsis</h1>
   9     <p><code>ovn-controller-vtep</code> [<var>options</var>]
  10     [<var>--vtep-db=vtep-database</var>] [<var>--ovnsb-db=ovnsb-database</var>]
  11     </p>
  12
  13     <h1>Description</h1>
  14     <p>
  15       <code>ovn-controller-vtep</code> is the local controller daemon in
  16       OVN, the Open Virtual Network, for VTEP enabled physical switches.
  17       It connects up to the OVN Southbound database (see
  18       <code>ovn-sb</code>(5)) over the OVSDB protocol, and down to the VTEP
  19       database (see <code>vtep</code>(5)) over the OVSDB protocol.
  20     </p>
  21
  22     <h1>Configuration</h1>
  23     <p>
  24       <code>ovn-controller-vtep</code> retrieves its configuration
  25       information from both the ovnsb and the vtep database.  If the
  26       database locations are not given from command line, the default
  27       is the <code>db.sock</code> in local OVSDB's 'run' directory.
  28       The datapath location must take one of the following forms:
  29     </p>
  30     <ul>
  31       <li>
  32         <p>
  33           <code>ssl:<var>ip</var>:<var>port</var></code>
  34         </p>
  35         <p>
  36           The specified SSL <var>port</var> on the host at the given
  37           <var>ip</var>, which must be expressed as an IP address (not a DNS
  38           name) in IPv4 or IPv6 address format.  If <var>ip</var> is an IPv6
  39           address, then wrap <var>ip</var> with square brackets, e.g.:
  40           <code>ssl:[::1]:6640</code>.  The <code>--private-key</code>,
  41           <code>--certificate</code> and either of <code>--ca-cert</code>
  42           or <code>--bootstrap-ca-cert</code> options are mandatory when this
  43           form is used.
  44         </p>
  45       </li>
  46       <li>
  47         <p>
  48           <code>tcp:<var>ip</var>:<var>port</var></code>
  49         </p>
  50         <p>
  51           Connect to the given TCP <var>port</var> on <var>ip</var>, where
  52           <var>ip</var> can be IPv4 or IPv6 address. If <var>ip</var> is an
  53           IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
  54           <code>tcp:[::1]:6640</code>.
  55         </p>
  56       </li>
  57       <li>
  58         <p>
  59           <code>unix:<var>file</var></code>
  60         </p>
  61         <p>
  62           On POSIX, connect to the Unix domain server socket named
  63           <var>file</var>.
  64         </p>
  65         <p>
  66           On Windows, connect to a localhost TCP port whose value is written
  67           in <var>file</var>.
  68         </p>
  69       </li>
  70     </ul>
  71 </manpage>