ovn/utilities/ovn-ctl.8.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <manpage program="ovn-ctl" section="8" title="ovn-ctl">
   3     <h1>Name</h1>
   4     <p>ovn-ctl -- Open Virtual Network northbound daemon lifecycle utility</p>
   5
   6     <h1>Synopsys</h1>
   7     <p><code>ovn-ctl</code> [<var>options</var>] <var>command</var></p>
   8
   9     <h1>Description</h1>
  10     <p>This program is intended to be invoked internally by Open Virtual Network
  11     startup scripts.  System administrators should not normally invoke it directly.</p>
  12
  13     <h1>Commands</h1>
  14
  15     <dl>
  16       <dt><code>start_northd</code></dt>
  17       <dt><code>start_controller</code></dt>
  18       <dt><code>stop_northd</code></dt>
  19       <dt><code>stop_controller</code></dt>
  20       <dt><code>restart_northd</code></dt>
  21       <dt><code>restart_controller</code></dt>
  22     </dl>
  23
  24     <h1>Options</h1>
  25     <p><code>--ovn-northd-priority=<var>NICE</var></code></p>
  26     <p><code>--ovn-northd-wrapper=<var>WRAPPER</var></code></p>
  27     <p><code>--ovn-controller-priority=<var>NICE</var></code></p>
  28     <p><code>--ovn-controller-wrapper=<var>WRAPPER</var></code></p>
  29     <p><code>-h</code> | <code>--help</code></p>
  30
  31     <h1>File location options</h1>
  32     <p><code>--db-sock==<var>SOCKET</var></code></p>
  33     <p><code>--db-nb-file==<var>FILE</var></code></p>
  34     <p><code>--db-sb-file==<var>FILE</var></code></p>
  35     <p><code>--db-nb-schema==<var>FILE</var></code></p>
  36     <p><code>--db-sb-schema==<var>FILE</var></code></p>
  37
  38     <h1>Example Usage</h1>
  39     <h2>Run ovn-controller on a host already running OVS</h2>
  40     <p><code># ovn-ctl start_controller</code></p>
  41
  42     <h2>Run ovn-northd on a host already running OVS</h2>
  43     <p><code># ovn-ctl start_northd</code></p>
  44
  45     <h2>All-in-one OVS+OVN for testing</h2>
  46     <p><code># ovs-ctl start --system-id="random"</code></p>
  47     <p><code># ovn-ctl start_northd</code></p>
  48     <p><code># ovn-ctl start_controller</code></p>
  49
  50 </manpage>