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>Synopsis</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>start_controller_vtep</code></dt>
  19       <dt><code>stop_northd</code></dt>
  20       <dt><code>stop_controller</code></dt>
  21       <dt><code>stop_controller_vtep</code></dt>
  22       <dt><code>restart_northd</code></dt>
  23       <dt><code>restart_controller</code></dt>
  24       <dt><code>restart_controller_vtep</code></dt>
  25       <dt><code>promote_ovnnb</code></dt>
  26       <dt><code>promote_ovnsb</code></dt>
  27       <dt><code>demote_ovnnb</code></dt>
  28       <dt><code>demote_ovnsb</code></dt>
  29       <dt><code>status_ovnnb</code></dt>
  30       <dt><code>status_ovnsb</code></dt>
  31     </dl>
  32
  33     <h1>Options</h1>
  34     <p><code>--ovn-northd-priority=<var>NICE</var></code></p>
  35     <p><code>--ovn-northd-wrapper=<var>WRAPPER</var></code></p>
  36     <p><code>--ovn-controller-priority=<var>NICE</var></code></p>
  37     <p><code>--ovn-controller-wrapper=<var>WRAPPER</var></code></p>
  38     <p><code>-h</code> | <code>--help</code></p>
  39
  40     <h1>File location options</h1>
  41     <p><code>--db-sock=<var>SOCKET</var></code></p>
  42     <p><code>--db-nb-file=<var>FILE</var></code></p>
  43     <p><code>--db-sb-file=<var>FILE</var></code></p>
  44     <p><code>--db-nb-schema=<var>FILE</var></code></p>
  45     <p><code>--db-sb-schema=<var>FILE</var></code></p>
  46     <p><code>--db-sb-create-insecure-remote=<var>yes|no</var></code></p>
  47     <p><code>--db-nb-create-insecure-remote=<var>yes|no</var></code></p>
  48     <p><code>--ovn-controller-ssl-key=<var>KEY</var></code></p>
  49     <p><code>--ovn-controller-ssl-cert=<var>CERT</var></code></p>
  50     <p><code>--ovn-controller-ssl-ca-cert=<var>CERT</var></code></p>
  51     <p><code>--ovn-controller-ssl-bootstrap-ca-cert=<var>CERT</var></code></p>
  52
  53     <h1>Address and port options</h1>
  54     <p><code>--db-nb-sync-from-addr=<var>IP ADDRESS</var></code></p>
  55     <p><code>--db-nb-sync-from-port=<var>PORT NUMBER</var></code></p>
  56     <p><code>--db-nb-sync-from-proto=<var>PROTO</var></code></p>
  57     <p><code>--db-sb-sync-from-addr=<var>IP ADDRESS</var></code></p>
  58     <p><code>--db-sb-sync-from-port=<var>PORT NUMBER</var></code></p>
  59     <p><code>--db-sb-sync-from-proto=<var>PROTO</var></code></p>
  60
  61     <h1>Configuration files</h1>
  62     <p>Following are the optional configuration files. If present, it should be located in the etc dir</p>
  63
  64     <h2>ovnnb-active.conf</h2>
  65     <p>
  66     If present, this file should hold the url to connect to the active
  67     Northbound DB server
  68     </p>
  69     <p><code>tcp:x.x.x.x:6641</code></p>
  70
  71     <h2>ovnsb-active.conf</h2>
  72     <p>
  73     If present, this file should hold the url to connect to the active
  74     Southbound DB server
  75     </p>
  76     <p><code>tcp:x.x.x.x:6642</code></p>
  77
  78     <h2>ovn-northd-db-params.conf</h2>
  79     <p>
  80     If present, start_northd will not start the DB server even if
  81     <code>--ovn-manage-ovsdb=yes</code>. This file should hold the database url
  82     parameters to be passed to ovn-northd.
  83     </p>
  84     <p><code>--ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642</code></p>
  85
  86     <h1>Example Usage</h1>
  87     <h2>Run ovn-controller on a host already running OVS</h2>
  88     <p><code># ovn-ctl start_controller</code></p>
  89
  90     <h2>Run ovn-northd on a host already running OVS</h2>
  91     <p><code># ovn-ctl start_northd</code></p>
  92
  93     <h2>All-in-one OVS+OVN for testing</h2>
  94     <p><code># ovs-ctl start --system-id="random"</code></p>
  95     <p><code># ovn-ctl start_northd</code></p>
  96     <p><code># ovn-ctl start_controller</code></p>
  97
  98     <h2>Promote and demote ovsdb servers</h2>
  99     <p><code># ovn-ctl promote_ovnnb</code></p>
 100     <p><code># ovn-ctl promote_ovnsb</code></p>
 101     <p><code># ovn-ctl --db-nb-sync-from-addr=x.x.x.x --db-nb-sync-from-port=6641 demote_ovnnb</code></p>
 102     <p><code># ovn-ctl --db-sb-sync-from-addr=x.x.x.x --db-sb-sync-from-port=6642 demote_ovnsb</code></p>
 103
 104 </manpage>