ovn/ovn-nbctl.8.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <manpage program="ovn-nbctl" section="8" title="ovn-nbctl">
   3     <h1>Name</h1>
   4     <p>ovn-nbctl -- Open Virtual Network northbound db management utility</p>
   5
   6     <h1>Synopsys</h1>
   7     <p><code>ovn-nbctl</code> [<var>options</var>] <var>command</var> [<var>arg</var>...]</p>
   8
   9     <h1>Description</h1>
  10     <p>This utility can be used to manage the OVN northbound database.</p>
  11
  12     <h1>Logical Switch Commands</h1>
  13
  14     <dl>
  15       <dt><code>lswitch-add</code> [<var>lswitch</var>]</dt>
  16       <dd>
  17         Creates a new logical switch named <var>lswitch</var>.  If
  18         <var>lswitch</var> is not provided, the switch will not have a
  19         name so other commands must refer to this switch by its UUID.
  20         Initially the switch will have no ports.
  21       </dd>
  22
  23       <dt><code>lswitch-del</code> <var>lswitch</var></dt>
  24       <dd>
  25         Deletes <var>lswitch</var>.
  26       </dd>
  27
  28       <dt><code>lswitch-list</code></dt>
  29       <dd>
  30         Lists all existing switches on standard output, one per line.
  31       </dd>
  32
  33       <dt><code>lswitch-set-external-id</code> <var>lswitch</var> <var>key</var> [<var>value</var>]</dt>
  34       <dd>
  35         <p>Sets or clears an ``external ID'' value on <var>lswitch</var>.
  36         These values are intended to identify entities external to OVN
  37         with which <var>lswitch</var> is associated.  The OVN Northbound
  38         database schema may specify well-known <var>key</var> values,
  39         but <var>key</var> and <var>value</var> are otherwise arbitrary
  40         strings.</p>
  41
  42         <p>If <var>value</var> is specified, then <var>key</var> is set to
  43         <var>value</var> for <var>lswitch</var>, overwriting any
  44         previous value.  If <var>value</var> is omitted, then
  45         <var>key</var> is removed from <var>lswitch</var>'s set of
  46         external IDs (if it was present.</p>
  47        </dd>
  48
  49       <dt><code>lswitch-get-external-id</code> <var>lswitch</var> [<var>key</var>]</dt>
  50       <dd>
  51         Queries the external IDs on <var>lswitch</var>.  If
  52         <var>key</var> is specified, the output is the value for that
  53         <var>key</var> or the empty string if <var>key</var> is unset.
  54         If <var>key</var> is omitted, the output is
  55         <var>key</var><code>=</code><var>value</var>, one per line, for
  56         each key-value pair.
  57       </dd>
  58     </dl>
  59
  60     <h1>Logical Port Commands</h1>
  61     <dl>
  62       <dt><code>lport-add</code> <var>lswitch</var> <var>lport</var></dt>
  63       <dd>
  64         Creates on <var>lswitch</var> a new logical port named
  65         <var>lport</var>.
  66       </dd>
  67
  68       <dt><code>lport-add</code> <var>lswitch</var> <var>lport</var> <var>parent</var> <var>tag</var></dt>
  69       <dd>
  70         Creates on <var>lswitch</var> a logical port named <var>lport</var>
  71         that is a child of <var>parent</var> that is identied with
  72         <var>tag</var>.  This is useful in cases such as virtualized
  73         container environments where Open vSwitch does not have a direct
  74         connection to the container's port and it must be shared with
  75         the virtual machine's port.
  76       </dd>
  77
  78       <dt><code>lport-del</code> <var>lport</var></dt>
  79       <dd>
  80         Deletes <var>lport</var>.
  81       </dd>
  82
  83       <dt><code>lport-list</code> <var>lswitch</var></dt>
  84       <dd>
  85         Lists all the logical ports within <var>lswitch</var> on
  86         standard output, one per line.
  87       </dd>
  88
  89       <dt><code>lport-get-parent</code> <var>lport</var></dt>
  90       <dd>
  91         If set, get the parent port of <var>lport</var>.  If not set, print
  92         nothing.
  93       </dd>
  94
  95       <dt><code>lport-get-tag</code> <var>lport</var></dt>
  96       <dd>
  97         If set, get the tag for <var>lport</var> traffic.  If not set, print
  98         nothing.
  99       </dd>
 100
 101       <dt><code>lport-set-external-id</code> <var>lport</var> <var>key</var> [<var>value</var>]</dt>
 102       <dd>
 103         <p>Sets or clears an ``external ID'' value on <var>lport</var>.
 104         These values are intended to identify entities external to OVN
 105         with which <var>lport</var> is associated.  The OVN Northbound
 106         database schema may specify well-known <var>key</var> values,
 107         but <var>key</var> and <var>value</var> are otherwise arbitrary
 108         strings.</p>
 109
 110         <p>If <var>value</var> is specified, then <var>key</var> is set to
 111         <var>value</var> for <var>lport</var>, overwriting any
 112         previous value.  If <var>value</var> is omitted, then
 113         <var>key</var> is removed from <var>lport</var>'s set of
 114         external IDs (if it was present.</p>
 115       </dd>
 116
 117       <dt><code>lport-get-external-id</code> <var>lport</var> [<var>key</var>]</dt>
 118       <dd>
 119         Queries the external IDs on <var>lport</var>.  If
 120         <var>key</var> is specified, the output is the value for that
 121         <var>key</var> or the empty string if <var>key</var> is unset.
 122         If <var>key</var> is omitted, the output is
 123         <var>key</var><code>=</code><var>value</var>, one per line, for
 124         each key-value pair.
 125       </dd>
 126
 127       <dt><code>lport-set-macs</code> <var>lport</var> [<var>mac</var>] [<var>mac</var>] [...]</dt>
 128       <dd>
 129         Sets the MACs associated with <var>lport</var> to
 130         <var>mac</var>.  Multiple MACs may be sets by using multiple
 131         <var>mac</var> arguments.  If no <var>mac</var> argument is
 132         given, <var>lport</var> will have no MACs associated with it.
 133       </dd>
 134
 135       <dt><code>lport-get-macs</code> <var>lport</var></dt>
 136       <dd>
 137         Lists all the MACs associated with <var>lport</var> on standard
 138         output, one per line.
 139       </dd>
 140
 141       <dt><code>lport-get-up</code> <var>lport</var></dt>
 142       <dd>
 143         Prints the state of <var>lport</var>, either <code>up</code> or
 144         <code>down</code>.
 145       </dd>
 146
 147     </dl>
 148
 149     <h1>Options</h1>
 150     <p><code>-d</code> <var>database</var> | <code>--db</code> <var>database</var></p>
 151     <p><code>-h</code> | <code>--help</code></p>
 152     <p><code>-o</code> | <code>--options</code></p>
 153     <p><code>-V</code> | <code>--version</code></p>
 154
 155     <h1>Logging options</h1>
 156     <p><code>-v</code><var>spec</var>, <code>--verbose=</code><var>spec</var></p>
 157     <p><code>-v</code>, <code>--verbose</code></p>
 158     <p><code>--log-file</code>[<code>=</code><var>file</var>]</p>
 159     <p><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></p>
 160
 161     <h1>PKI configuration (required to use SSL)</h1>
 162     <p><code>-p</code>, <code>--private-key=</code><var>file</var>  file with private key</p>
 163     <p><code>-c</code>, <code>--certificate=</code><var>file</var>  file with certificate for private key</p>
 164     <p><code>-C</code>, <code>--ca-cert=</code><var>file</var>      file with peer CA certificate</p>
 165
 166 </manpage>