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-del</code> <var>lport</var></dt>
  69       <dd>
  70         Deletes <var>lport</var>.
  71       </dd>
  72
  73       <dt><code>lport-list</code> <var>lswitch</var></dt>
  74       <dd>
  75         Lists all the logical ports within <var>lswitch</var> on
  76         standard output, one per line.
  77       </dd>
  78
  79       <dt><code>lport-set-external-id</code> <var>lport</var> <var>key</var> [<var>value</var>]</dt>
  80       <dd>
  81         <p>Sets or clears an ``external ID'' value on <var>lport</var>.
  82         These values are intended to identify entities external to OVN
  83         with which <var>lport</var> is associated.  The OVN Northbound
  84         database schema may specify well-known <var>key</var> values,
  85         but <var>key</var> and <var>value</var> are otherwise arbitrary
  86         strings.</p>
  87
  88         <p>If <var>value</var> is specified, then <var>key</var> is set to
  89         <var>value</var> for <var>lport</var>, overwriting any
  90         previous value.  If <var>value</var> is omitted, then
  91         <var>key</var> is removed from <var>lport</var>'s set of
  92         external IDs (if it was present.</p>
  93       </dd>
  94
  95       <dt><code>lport-get-external-id</code> <var>lport</var> [<var>key</var>]</dt>
  96       <dd>
  97         Queries the external IDs on <var>lport</var>.  If
  98         <var>key</var> is specified, the output is the value for that
  99         <var>key</var> or the empty string if <var>key</var> is unset.
 100         If <var>key</var> is omitted, the output is
 101         <var>key</var><code>=</code><var>value</var>, one per line, for
 102         each key-value pair.
 103       </dd>
 104
 105       <dt><code>lport-set-macs</code> <var>lport</var> [<var>mac</var>] [<var>mac</var>] [...]</dt>
 106       <dd>
 107         Sets the MACs associated with <var>lport</var> to
 108         <var>mac</var>.  Multiple MACs may be sets by using multiple
 109         <var>mac</var> arguments.  If no <var>mac</var> argument is
 110         given, <var>lport</var> will have no MACs associated with it.
 111       </dd>
 112
 113       <dt><code>lport-get-macs</code> <var>lport</var></dt>
 114       <dd>
 115         Lists all the MACs associated with <var>lport</var> on standard
 116         output, one per line.
 117       </dd>
 118
 119       <dt><code>lport-get-up</code> <var>lport</var></dt>
 120       <dd>
 121         Prints the state of <var>lport</var>, either <code>up</code> or
 122         <code>down</code>.
 123       </dd>
 124
 125     </dl>
 126
 127     <h1>Options</h1>
 128     <p><code>-d</code> <var>database</var> | <code>--db</code> <var>database</var></p>
 129     <p><code>-h</code> | <code>--help</code></p>
 130     <p><code>-o</code> | <code>--options</code></p>
 131     <p><code>-V</code> | <code>--version</code></p>
 132
 133     <h1>Logging options</h1>
 134     <p><code>-v</code><var>spec</var>, <code>--verbose=</code><var>spec</var></p>
 135     <p><code>-v</code>, <code>--verbose</code></p>
 136     <p><code>--log-file</code>[<code>=</code><var>file</var>]</p>
 137     <p><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></p>
 138
 139     <h1>PKI configuration (required to use SSL)</h1>
 140     <p><code>-p</code>, <code>--private-key=</code><var>file</var>  file with private key</p>
 141     <p><code>-c</code>, <code>--certificate=</code><var>file</var>  file with certificate for private key</p>
 142     <p><code>-C</code>, <code>--ca-cert=</code><var>file</var>      file with peer CA certificate</p>
 143
 144 </manpage>